Platon Technologies
not logged in Login Registration
EnglishSlovak
open source software development celebrating 10 years of open source development! Friday, October 16, 2026
[BACK] [TXT][DIR] Up to [Platon] / doc / soft-doc-sys / sgml / sk

Diff for doc/soft-doc-sys/sgml/sk/developer-doc-systems.sgml between version 1.6 and 1.7

version 1.6, 2002/12/16 13:04:09 version 1.7, 2002/12/16 18:01:22
Line 1 
Line 1 
 <!-- $Platon: Platon.SK/doc-projects/soft-doc-sys/sk/developer-doc-systems.sgml,v 1.5 2002/12/16 12:51:33 nepto Exp $ -->  <!-- $Platon: Platon.SK/doc-projects/soft-doc-sys/sk/developer-doc-systems.sgml,v 1.6 2002/12/16 13:04:09 nepto Exp $ -->
   
 <chapter id="developer-doc-sys"><title>Systémy vývojárskej dokumentácie softvéru</title>  <chapter id="developer-doc-sys"><title>Systémy vývojárskej dokumentácie softvéru</title>
   
Line 7 
Line 7 
 Pre generovanie vývojárskej dokumentácie existuje viacero nástrojov v závislosti  Pre generovanie vývojárskej dokumentácie existuje viacero nástrojov v závislosti
 na tom, v akom programovacom jazyku je aplikácia napísaná. Pre <acronym>C/C++</>  na tom, v akom programovacom jazyku je aplikácia napísaná. Pre <acronym>C/C++</>
 je to <ulink url="http://www.doxygen.org/"><productname>Doxygen</></>, ktorý sa  je to <ulink url="http://www.doxygen.org/"><productname>Doxygen</></>, ktorý sa
 vyvinul z <ulink url="http://www.doc++.org/"><productname>Doc++</></>. Pre  vyvinul z <ulink url="http://docpp.sourceforge.net/"><productname>Doc++</></>.
 programovací jazyk <acronym>PHP</> poznáme hneď niekoľko nástrojov: <ulink  Pre programovací jazyk <acronym>PHP</> poznáme hneď niekoľko nástrojov: <ulink
 url="http://www.phpdoc.de/"><productname>phpDoc</></>, <productname>phpDoc2</>,  url="http://www.phpdoc.de/"><productname>phpDoc</></>, <ulink
 <ulink url="http://www.phpdocumentator.org/"><productname>phpDocumentator</></>  url="http://www.phpdoc.org/"><productname>phpDocumentor</></>,
 a <ulink url="http://www.peardoc.org/"><productname>PearDoc</></>. Posledný z  <productname>PearDoc</> a <ulink
   url="http://pear.php.net/manual/"><productname>PearDoc2</></>. Posledný z
 menovaných má pred sebou zrejme najlepšiu budúcnosť, nakoľko je aktívne vyvíjaný  menovaných má pred sebou zrejme najlepšiu budúcnosť, nakoľko je aktívne vyvíjaný
 a zrejme sa stane hlavným dokumentačným nástrojom pre <acronym>PHP</>. Nakoniec  a zrejme sa stane hlavným dokumentačným nástrojom pre <acronym>PHP</>. Nakoniec
 pre programovací jazyk <acronym>Java</> je to známy <ulink  pre programovací jazyk <acronym>Java</> je to známy <ulink
 url="http://www.javadoc.org/"><productname>JavaDoc</></>.  url="http://java.sun.com/j2se/javadoc/"><productname>JavaDoc</></>.
   
 </para>  </para>
 <para>  <para>
Line 37  spomenuté, vývojársku dokumentáciu je vh
Line 38  spomenuté, vývojársku dokumentáciu je vh
 aplikácie. A tak napríklad po pridaní novej metódy sa k nej zároveň napíše aj  aplikácie. A tak napríklad po pridaní novej metódy sa k nej zároveň napíše aj
 jednoduchý komentár, ktorý je jednak použiteľný pre informovanie o funkčnosti  jednoduchý komentár, ktorý je jednak použiteľný pre informovanie o funkčnosti
 metódy priamo v zdrojovom kóde a samozrejme bude tiež použitý na vygenerovanie  metódy priamo v zdrojovom kóde a samozrejme bude tiež použitý na vygenerovanie
 vývojárskej dokumentácie. Klasické komentáre je možné v zdrojovom kóde použivať  vývojárskej dokumentácie. Klasické komentáre je možné v zdrojovom kóde používať
 aj naďalej, do dokumentácie zahrnuté nebudú.  aj naďalej, do dokumentácie zahrnuté nebudú.
   
 </para>  </para>
Line 46  aj naďalej, do dokumentácie zahrnuté neb
Line 47  aj naďalej, do dokumentácie zahrnuté neb
 Treba zdôrazniť, že dokumentačné systémy sú schopné veľké množstvo poznatkov  Treba zdôrazniť, že dokumentačné systémy sú schopné veľké množstvo poznatkov
 odvodiť priamo zo zdrojového kódu, keďže v sebe spravidla obsahujú analyzátory  odvodiť priamo zo zdrojového kódu, keďže v sebe spravidla obsahujú analyzátory
 daného programovacieho jazyka. Napríklad do dokumentačného komentáru ku funkcii,  daného programovacieho jazyka. Napríklad do dokumentačného komentáru ku funkcii,
 metóde alebo triede nie je nutné písať jej meno, keďže to sa dá odvodiť<!-- EN:  metóde alebo triede nie je nutné písať jej meno, keďže to sa dá odvodiť z
 extract --> z príslušnej deklarácie. Toto je aj hlavný dôvod, prečo pre každý  príslušnej deklarácie. Toto je aj hlavný dôvod, prečo pre každý programovací
 programovací jazyk existujú odlišné dokumentačné nástroje vývojárskej  jazyk existujú odlišné dokumentačné nástroje vývojárskej dokumentácie, napriek
 dokumentácie, napriek tomu, že ich použitie je v zásade totožné.  tomu, že ich použitie je v zásade totožné.
   
 </para>  </para>
 <para>  <para>
Line 66  spoločné črty, ktoré su pre všetky systé
Line 67  spoločné črty, ktoré su pre všetky systé
   
 <example>  <example>
 <title>Zdokumentovaný <acronym>C++</> zdrojový kód pre <productname>Doxygen</></title>  <title>Zdokumentovaný <acronym>C++</> zdrojový kód pre <productname>Doxygen</></title>
 <!-- EN: <title>Documented <acronym>C++</> source code for <productname>Doxygen</></title> -->  
 <programlisting><![CDATA[  <programlisting><![CDATA[
 /**  /**
  * Example class   * Example class
Line 100  class Example
Line 100  class Example
   
 <example>  <example>
 <title>Zdokumentovaný <acronym>PHP</> zdrojový kód pre <productname>PearDoc</></title>  <title>Zdokumentovaný <acronym>PHP</> zdrojový kód pre <productname>PearDoc</></title>
 <!-- EN: <title>Documented <acronym>PHP</> source code for <productname>PearDoc</></title> -->  
 <programlisting><![CDATA[  <programlisting><![CDATA[
 /**  /**
  * Example class   * Example class
Line 131  class Example
Line 130  class Example
   
 <example>  <example>
 <title>Zdokumentovaný <acronym>Java</> zdrojový kód pre <productname>JavaDoc</></title>  <title>Zdokumentovaný <acronym>Java</> zdrojový kód pre <productname>JavaDoc</></title>
 <!-- EN: <title>Documented <acronym>Java</> source code for <productname>JavaDoc</></title> -->  
 <programlisting><![CDATA[  <programlisting><![CDATA[
 /**  /**
  * Example class   * Example class
Line 186  opis návratovej hodnoty parametru funkci
Line 184  opis návratovej hodnoty parametru funkci
 <member> &nbsp; <token>@since</></><member> -- minimálna verzia zabezpečujúca funkčnosť (TODO)</>  <member> &nbsp; <token>@since</></><member> -- minimálna verzia zabezpečujúca funkčnosť (TODO)</>
 <member> &nbsp; <token>@deprecated</></><member> -- TODO</>  <member> &nbsp; <token>@deprecated</></><member> -- TODO</>
 <member> &nbsp; <token>@see</></><member> -- odkaz na súvisiacu entity</>  <member> &nbsp; <token>@see</></><member> -- odkaz na súvisiacu entity</>
 <member> &nbsp; <token>@todo</></><member> -- popis nedokončných vymožeností<!-- EN: features --></>  <member> &nbsp; <token>@todo</></><member> -- popis nedokončných vymožeností</>
 </simplelist>  </simplelist>
   
 </para>  </para>
 <para>  <para>
   
 <!-- Príklad použitia: -->  
   
 <example>  <example>
 <title>Použitie ďaľších dokumentačných značiek</title>  <title>Použitie ďaľších dokumentačných značiek</title>
 <programlisting><![CDATA[  <programlisting><![CDATA[
Line 229  class Extensive_Example
Line 225  class Extensive_Example
 <para>  <para>
   
 Podobne ako pri užívateľskej dokumentácii je aj tu možnosť vygenerovať finálnu  Podobne ako pri užívateľskej dokumentácii je aj tu možnosť vygenerovať finálnu
 dokumentáciu vo viacerých formátoch. Aplikácia  dokumentáciu vo viacerých formátoch. Aplikácia <productname>Doxygen</> podporuje
 <productname>Doxygen</productname> podporuje nasledovné výstupné formáty:  nasledovné výstupné formáty: <acronym>HTML</>, <application>LaTeX</>,
 <acronym>HTML</>, <application>LaTeX</>, <acronym>RTF</>, <acronym>XML</> a  <acronym>RTF</>, <acronym>XML</> a manuálové stránky. Všetko sa konfiguruje
 manuálové stránky. Všetko sa konfiguruje pomocou prehľadného konfiguračného  pomocou prehľadného konfiguračného súboru <filename>Doxyfile</>. Pokial spustíte
 súboru <filename>Doxyfile</>. Pokial spustíte program <command>doxygen</> s  program <command>doxygen</> s prepínačom <option>-g</>, základný konfiguračný
 prepínačom <option>-g</>, základný<!-- EN: default --> konfiguračný súbor bude  súbor bude zapísaný na disk. Obsahuje veľa komentárov, takže jeho modifikácia je
 zapísaný na disk. Obsahuje veľa komentárov, takže jeho modifikácia je jednoduchá  jednoduchá a priamočiara. Samotná generácia dokumentácie prebieha nasledovným
 a priamočiara<!-- EN: straightforward -->. Samotná generácia dokumentácie  príkazom:
 prebieha nasledovným príkazom:  
   
 <literallayout>  <literallayout>
 <prompt>$ </><userinput> doxygen</userinput>  <prompt>$ </><userinput> doxygen</userinput>
Legend:
Removed from v.1.6  
changed lines
  Added in v.1.7
Platon Group <platon@platon.org> http://platon.org/
Copyright © 2002-2006 Platon Group
Site powered by Metafox CMS 		Go to Top