Natural Docs
 | This article has multiple issues. Please help improve it or discuss these issues on the talk page. (Learn how and when to remove these template messages)
|
 | |
| Original author(s) | Greg Valure |
|---|---|
| Stable release | 2.0.2
/ May 15, 2018 |
| Repository | |
| Written in | C# (Perl before 2.0)[1] |
| Operating system | Cross-platform |
| Type | Documentation generator |
| License | AGPL |
| Website | NaturalDocs.org |
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[edit]
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."[2] It is used by some hobbyists and companies, such as CNET Networks, Inc. and Iron Realms Entertainment.[3][4] 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[edit]
This is an example of the documentation style:
/*
* Function: Multiply
*
* Multiplies two integers.
*
* Parameters:
* x - The first integer.
* y - The second integer.
*
* Returns:
* The two integers multiplied together.
*
* See Also:
* <Divide>
*/
int Multiply (int x, int y)
{ return x * y; }
For comparison, this is how the same thing would be documented with Javadoc:
/**
* Multiplies two integers.
*
* @param x The first integer.
* @param y The second integer.
* @return The two integers multiplied together.
* @see Divide
*/
int Multiply (int x, int y)
{ return x * y; }
See also[edit]
Notes and references[edit]
- ^ About Natural Docs
- ^ Natural Docs Languages
- ^ CNET's Global Framework by CNET Networks, Inc. and generated documentation using Natural Docs
- ^ Rapture by Iron Realms Entertainment and generated documentation using Natural Docs