| Natural Docs |
Article Index for Natural |
Website Links For Natural |
Information AboutNatural Docs |
| CATEGORIES ABOUT NATURAL DOCS | |
| free documentation generators | |
|
Natural Docs is a multi-language Documentation Generator . It is written in Perl and is available for no cost under the terms of the GNU General Public License . 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. Theoretically, it 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 2.0 , 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 developers because no other free documentation generator exists that fully supports ActionScript 2.0 and because it generates higher-quality output than similar generators that partially supports the language, such as ROBODoc . EXAMPLE This is an example of the documentation style. See the full syntax reference for more details.
int Multiply (int x, int y)
In comparison with Javadoc , the same thing would be documented as the following in source code. Note how the Javadoc tags makes the source code harder to read than the above example.
int Multiply (int x, int y)
You can also see an example of the generated documentation. SEE ALSO NOTES AND REFERENCES FURTHER READING |
|
|