Natural Docs is an extensible, multi-language documentation generator.
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.
When executed, Natural Docs can automatically document functions, variables, classes, and inheritance from ActionScript, C#, and Perl regardless of existing documentation in the source code. For the other languages listed below, these need to be explicitly documented for them to be generated.
Natural Docs focuses on automation and high-quality HTML output.
Key Features
- Source Documentation/l
- Natural, readable syntax.
-
- Multiple languages are supported: C#, Perl, ActionScript (2 and 3), C/C++, Java,PHP,
Python, PL/SQL, Visual Basic, Pascal/Delphi, Ada, JavaScript, Ruby, Tcl, ColdFusion, Assembly, Fortran, R, Makefiles, Plain Text.
- Multiple languages are supported: C#, Perl, ActionScript (2 and 3), C/C++, Java,PHP,
-
- Document everything or only what you want documented.
-
- Javadoc compatible.
-
- Flexible Keywords.
-
- Custom Topics and Indexed.
-
- Lists.
- Images – embed images in your documentation just by writing so it makes sense when you’re reading it from the source code instead of looking like a HTML tag.
- Syntax highlighting.
- Support for named links.
- Generated Output:
- Professional output.
- CSS structure.
- Framed/unframed HTML.
- Search performed in DHTML.
- Tooltips.
- Program:
- Differential Build Process.
- Extensible Architecture.
- Portable.
- Intelligent configuration files.
Website: www.naturaldocs.org
Support: GitHub Code Repository
Developer: Greg Valure
License: GNU Affero General Public License v3.0
Natural Docs is written in C#. Learn C# with our recommended free books and free tutorials.
Related Software
| Documentation Generators | |
|---|---|
| JSDoc | API documentation generator for JavaScript |
| Javadoc | Generate API documentation in HTML format |
| Sphinx | Create intelligent and beautiful documentation for Python projects |
| phpDocumentor | Complete documentation solution for PHP |
| Doxygen | Documentation system for C, C++, Java, Python and other languages |
| Docusaurus | Build, deploy and maintain documentation websites |
| mdBook | Create modern online books from Markdown files |
| YARD | Ruby documentation tool |
| Starlight | Documentation website framework |
| Docco | Literate-programming-style documentation generator |
| Natural Docs | Documentation generator that supports 21 different languages |
| Quarto | Scientific and technical publishing system |
| Antora | Modular documentation site generator |
| Crycco | Quick and dirty documentation generator |
| ROBODoc | Documentation tool similar to Javadoc |
Read our verdict in the software roundup.
 Explore our comprehensive directory of recommended free and open source software. Our carefully curated collection spans every major software category.This directory is part of our ongoing series of informative articles for Linux enthusiasts. It features hundreds of detailed reviews, along with open source alternatives to proprietary solutions from major corporations such as Google, Microsoft, Apple, Adobe, IBM, Cisco, Oracle, and Autodesk. You’ll also find interesting projects to try, hardware coverage, free programming books and tutorials, and much more. Discovered a useful open source Linux program that we haven’t covered yet? Let us know by completing this form. |