Pages

Tuesday, March 05, 2013

Source Code documentation: what JavaDoc should look like, and why.

Over the years, I have blogged quite a bit about JavaDoc. JavaDoc is the system commonly used to annotate Java source code for human oriented documentation, and complement source code comments. I will not attempt to summarize what I wrote in the past, but will give some links. The primary user of the JavaDoc is, of course, the user:
And we take effort in producing good JavaDoc (despite it being the unpaid, least favorite task):
And we use tools here to support us:
And using JavaDoc taglets and doclets, we enrich the regular JavaDoc with more detailed information:
The CDK uses the JavaDoc not just for documentation, but also for compiler instructions: