Documenting Anything

Some document generators are as smart as compilers and can figure out what is a function, what is a subroutine, etc for all language specific elements.  This is true for database documenters that only reference the system tables.  This documenation isn’t as exciting as it could be, because it just repeats what is usually available with a database or class browser.
Some document generators are entirely on hand generated code.  This is a bit more tedious because if you forget to add the comment templates, the document generator won’t notice. Examples: RoboDoc, Natural Docs
And of course some are in between, which automatically generate documentation from the structure of the class and add tagged comments when available.  Examples: (mostly commercial stuff)

Comments are closed.