| version 1.7, 2002/12/16 18:01:22 |
version 1.8, 2002/12/17 22:32:05 |
|
|
| <!-- $Platon: Platon.SK/doc-projects/soft-doc-sys/sk/developer-doc-systems.sgml,v 1.6 2002/12/16 13:04:09 nepto Exp $ --> |
<!-- $Platon: Platon.SK/doc-projects/soft-doc-sys/sk/developer-doc-systems.sgml,v 1.7 2002/12/16 18:01:22 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> |
| <para> |
<para> |
| |
|
| 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 |
| Line 65 spoločné črty, ktoré su pre všetky systé |
|
| Line 65 spoločné črty, ktoré su pre všetky systé |
|
| </para> |
</para> |
| <para> |
<para> |
| |
|
| <example> |
<example id="developer-doc-sys.doxygen-example"> |
| <title>Zdokumentovaný <acronym>C++</> zdrojový kód pre <productname>Doxygen</></title> |
<title>Zdokumentovaný <acronym>C++</> zdrojový kód pre <productname>Doxygen</></title> |
| <programlisting><![CDATA[ |
<programlisting><![CDATA[ |
| /** |
/** |
|
|
| ]]></programlisting> |
]]></programlisting> |
| </example> |
</example> |
| |
|
| <example> |
<example id="developer-doc-sys.peardoc-example"> |
| <title>Zdokumentovaný <acronym>PHP</> zdrojový kód pre <productname>PearDoc</></title> |
<title>Zdokumentovaný <acronym>PHP</> zdrojový kód pre <productname>PearDoc</></title> |
| <programlisting><![CDATA[ |
<programlisting><![CDATA[ |
| /** |
/** |
|
|
| ]]></programlisting> |
]]></programlisting> |
| </example> |
</example> |
| |
|
| <example> |
<example id="developer-doc-sys.javadoc-example"> |
| <title>Zdokumentovaný <acronym>Java</> zdrojový kód pre <productname>JavaDoc</></title> |
<title>Zdokumentovaný <acronym>Java</> zdrojový kód pre <productname>JavaDoc</></title> |
| <programlisting><![CDATA[ |
<programlisting><![CDATA[ |
| /** |
/** |
| Line 181 opis návratovej hodnoty parametru funkci |
|
| Line 181 opis návratovej hodnoty parametru funkci |
|
| <member> <token>@author</></><member> -- autor entity (triedy, metódy, funkcie)</> |
<member> <token>@author</></><member> -- autor entity (triedy, metódy, funkcie)</> |
| <member> <token>@version</></><member> -- verzia entity</> |
<member> <token>@version</></><member> -- verzia entity</> |
| <member> <token>@date</></><member> -- dátum vzniku</> |
<member> <token>@date</></><member> -- dátum vzniku</> |
| <member> <token>@since</></><member> -- minimálna verzia zabezpečujúca funkčnosť (TODO)</> |
<member> <token>@since</></><member> -- minimálna verzia majúca nejakú funkcionalitu</> |
| <member> <token>@deprecated</></><member> -- TODO</> |
<member> <token>@deprecated</></><member> -- stará a už nepodporovaná funkcionalita</> |
| <member> <token>@see</></><member> -- odkaz na súvisiacu entity</> |
<member> <token>@see</></><member> -- odkaz na súvisiacu entity</> |
| <member> <token>@todo</></><member> -- popis nedokončných vymožeností</> |
<member> <token>@todo</></><member> -- popis nedokončných vymožeností</> |
| </simplelist> |
</simplelist> |
| Line 190 opis návratovej hodnoty parametru funkci |
|
| Line 190 opis návratovej hodnoty parametru funkci |
|
| </para> |
</para> |
| <para> |
<para> |
| |
|
| <example> |
<example id="developer-doc-sys.advanced-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 200 opis návratovej hodnoty parametru funkci |
|
| Line 200 opis návratovej hodnoty parametru funkci |
|
| * |
* |
| * @author Ondrej Jombik <nepto@pobox.sk> |
* @author Ondrej Jombik <nepto@pobox.sk> |
| * @author Ondrej Holotnak <beast@host.sk> |
* @author Ondrej Holotnak <beast@host.sk> |
| * @version 1.0 |
* @version ]]>&version;<![CDATA[ |
| * @date 2002-12-11 |
* @date ]]>&name;<![CDATA[ |
| */ |
*/ |
| class Extensive_Example |
class Extensive_Example |
| { |
{ |