- Source: Natural Docs
Natural Docs is a multi-language documentation generator. It is written in C# and available as free software under the terms of the AGPL. It attempts to keep the comments written in source code just as readable as the generated documentation. It is written and maintained by Greg Valure.
Background
Theoretically, Natural Docs can generate documentation from any language that can support comments, or from plain text files. When executed, it can automatically document functions, variables, classes, and inheritance from ActionScript, C#, and Perl regardless of existing documentation in the source code. In all other languages, these need to be explicitly documented for them to be generated. It can generate documentation in HTML, either with frames or without.
Unlike Javadoc, it is not considered an industry standard for documenting in any language, although it can incorporate Javadoc documentation for languages with "full support." It is used by some hobbyists and companies, such as CNET Networks, Inc. and Iron Realms Entertainment. It has gained popularity amongst ActionScript developers because no other free documentation generator exists that fully supports ActionScript and because it generates higher-quality output than similar generators that partially support the language, such as ROBODoc.
Example
This is an example of the documentation style:
For comparison, this is how the same thing would be documented with Javadoc:
See also
Comparison of documentation generators
Notes and references
Further reading
Natural Docs Home Page
List of features
List of supported languages
Kata Kunci Pencarian:
- Australia
- Estradiol valerat
- The Road
- Testosteron undekanoat
- Metasomatisme
- Lintah
- Ordo Militer Berdaulat Malta
- Daftar kata yang dilindungi di SQL
- Chili
- 0 (angka)
- Natural Docs
- Comparison of documentation generators
- PL/pgSQL
- Doc
- Google Drive
- Google Sheets
- The D.O.C.
- Doc Holliday
- List of free and open-source software packages
- Etna DOC
