Chapter 6. Generating documentation
| 6.1 | The importance of structured comments |
| 6.2 | The big picture |
| 6.3 | A case study: augmented SQL code |
| 6.4 | Understanding the JavaDoc and the Doclet API |
| 6.5 | Finding a tool to do it for you |
| 6.6 | Summary |
It seems that every new language promises “self-documenting code”—code so clear that an engineer will be able to divine its purpose just by reading it. No commonly used language has ever succeeded at meeting the self-documenting challenge, but a few advances have made it easier for us to create well-documented code. Tools such as POD (for Perl), JavaDoc (for Java), and Doxygen (for C++) allow ...
Get Code Generation in Action now with the O’Reilly learning platform.
O’Reilly members experience books, live events, courses curated by job role, and more from O’Reilly and nearly 200 top publishers.
