Přírodní dokumenty - Natural Docs
 | Tento článek má několik problémů. Prosím pomozte zlepšit to nebo diskutovat o těchto otázkách na internetu diskusní stránka. (Zjistěte, jak a kdy tyto zprávy ze šablony odebrat) (Zjistěte, jak a kdy odstranit tuto zprávu šablony)
|
 | |
| Původní autoři | Greg Valure |
|---|---|
| Stabilní uvolnění | 2.0.2 / 15. května 2018 |
| Úložiště |  |
| Napsáno | C# (Perl před 2.0)[1] |
| Operační systém | Cross-platform |
| Typ | Generátor dokumentace |
| Licence | Obecná veřejná licence Affero |
| webová stránka | NaturalDocs.org |
Přírodní dokumenty je vícejazyčný generátor dokumentace. Je napsán v C# a k dispozici jako svobodný software podle podmínek Obecná veřejná licence Affero. Pokouší se udržovat komentáře napsané zdrojový kód stejně čitelné jako vygenerovaná dokumentace. Je napsán a udržován Gregem Valure.
Pozadí
Teoreticky může Natural Docs generovat dokumentaci z jakéhokoli jazyka, který podporuje komentáře, nebo ze souborů ve formátu prostého textu. Po spuštění může automaticky dokumentovat funkce, proměnné, třídy a dědičnost ActionScript, C#, a Perl bez ohledu na existující dokumentaci ve zdrojovém kódu. Ve všech ostatních jazycích musí být výslovně zdokumentovány, aby mohly být generovány. Může generovat dokumentaci v HTML, buď s rámečky, nebo bez.
Na rozdíl od Javadoc, není považován za průmyslový standard pro dokumentaci v jakémkoli jazyce, i když může obsahovat dokumentaci Javadoc pro jazyky s „plnou podporou“.[2] Používají ho někteří fandové a společnosti, jako např CNET Networks, Inc. a Iron Realms Entertainment.[3][4] To získalo popularitu mezi ActionScript vývojáři, protože neexistuje žádný jiný bezplatný generátor dokumentace, který plně podporuje ActionScript, a protože generuje kvalitnější výstup než podobné generátory, které jazyk částečně podporují, například ROBODoc.
Příklad
Toto je příklad stylu dokumentace:
/* * Funkce: Násobení * * Násobí dvě celá čísla. * * Parametry: * x - první celé číslo. * y - druhé celé číslo. * * Vrací: * Dvě celá čísla vynásobená dohromady. * * Viz také: * Pro srovnání, takto by bylo dokumentováno to samé Javadoc:
/** * Násobí dvě celá čísla. * * @param x První celé číslo. * @param y Druhé celé číslo. * @return Dvě celá čísla vynásobená společně. * @ viz Rozdělit */ int Násobit (int X, int y) { vrátit se X * y; }Viz také
Poznámky a odkazy
- ^ O dokumentech Natural Docs
- ^ Přirozené jazyky dokumentů
- ^ Globální rámec CNET podle CNET Networks, Inc. a vygenerovaná dokumentace pomocí Natural Docs
- ^ Extáze podle Iron Realms Entertainment a vygenerovaná dokumentace pomocí Natural Docs