NaturalDocs allows developers to review and share their code comments in a browser. ActionScript, C#, and Perl developers should consider using this documentation generator because these languages are fully supported by NaturalDocs. Fully supported languages come with the following features:
- Implicit comment generation
- Inheritence diagrams
- Automatic scope detection
Read on to see if NaturalDocs is the right tool for the job.
What is NaturalDocs?
NaturalDocs generates HTML documentation from comments found in source files. From the NaturalDocs website:
Natural Docs is an open-source documentation generator for multiple programming languages. You document your code in a natural syntax that reads like plain English. Natural Docs then scans your code and builds high-quality HTML documentation from it.
Why Should I Use NaturalDocs?
- NaturalDocs strives to be unobtrusive and natural for programmers. The comment syntax is easy to learn and maintain.
- Automation is simple with a Windows Batch File.
- You develop in C#, Perl, ActionScript 2, or ActionScript 3 and wish to share your comments with other developers. HTML-based documentation is easier to navigate and view than comments in source files.
- You document your code with JavaDoc and wish to change documentation generators. NaturalDocs supports JavaDoc style comments so the change will have few impacts on your development procedures.
- You do not generate documentation for your code.
Why Should I Not Use NaturalDocs?
- Your organization already uses a documentation generator. Developers will need to change their commenting style and use a different process to generate documentation. Make the switch after evaluating the changes carefully.
- You develop in a programming language that has basic language support and desire robust documentation options.
- You use an editor that automatically inserts comments for another documentation generator. For example the Zend IDE auto-inserts comment blocks intended for PHPDoc if you type /** and press enter. Don’t waste time modifying what your editor is inserting automatically!
Tags: Documentation, NaturalDocs