Natural Docs – readable source code documentation for 21 programming languages

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.

Features include:

  • 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.
    • 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 AGPL v3

Natural Docs is written in C#. Learn C# with our recommended free books and free tutorials.

Return to Documentation Generators Home Page


Popular series
Guide to LinuxNew to Linux? Read our Linux for Starters series. We start right at the basics and teach you everything you need to know to get started with Linux.
Free and Open Source SoftwareThe largest compilation of the best free and open source software in the universe. Each article is supplied with a legendary ratings chart helping you to make informed decisions.
ReviewsHundreds of in-depth reviews offering our unbiased and expert opinion on software. We offer helpful and impartial information.
Alternatives to Proprietary SoftwareReplace proprietary software with open source alternatives: Google, Microsoft, Apple, Adobe, IBM, Autodesk, Oracle, Atlassian, Corel, Cisco, Intuit, and SAS.
Linux Around The WorldLinux Around The World showcases events and usergroups that are Linux-related. This is a new series.
DockerGetting Started with Docker helps you master Docker, a set of platform as a service products that delivers software in packages called containers.
System ToolsEssential Linux system tools focuses on small, indispensable utilities, useful for system administrators as well as regular users.
ProductivityLinux utilities to maximise your productivity. Small, indispensable tools, useful for anyone running a Linux machine.
Home ComputersHome computers became commonplace in the 1980s. Emulate home computers including the Commodore 64, Amiga, Atari ST, ZX81, Amstrad CPC, and ZX Spectrum.
Now and ThenNow and Then examines how promising open source software fared over the years. It can be a bumpy ride.
Linux at HomeLinux at Home looks at a range of home activities where Linux can play its part, making the most of our time at home, keeping active and engaged.
Linux CandyLinux Candy reveals the lighter side of Linux. Have some fun and escape from the daily drudgery.
Android AppsBest Free Android Apps. We showcase free Android apps that are definitely worth downloading. There's a strict eligibility criteria for inclusion in this series.
Programming BooksThese best free books accelerate your learning of every programming language. Learn a new language today!
Programming TutorialsThese free tutorials offer the perfect tonic to our free programming books series.
Stars and StripesStars and Stripes is an occasional series looking at the impact of Linux in the USA.
Share this article

Share your Thoughts

This site uses Akismet to reduce spam. Learn how your comment data is processed.