WebliminalBlog

I’m teaching a section of Object-oriented Analysis & Design. We’re using java, and so we’re using Javadoc. Here are some links to which I refer my students.

• How to Write Doc Comments for the Javadoc Tool
  This document describes the style guide, tag and image conventions we use in documentation comments for Java programs written at Java Software, Sun Microsystems. It does not rehash related material covered elsewhere:  For reference material on Javadoc tags, see the Javadoc reference pages.  

  For the required semantic content of documentation comments, see Requirements for Writing Java API Specifications.

  (tags: reference javadoc documentation standards Guidelinescomments coding)
• Javadoc (tags: tutorial javadoc) 
• Java theory and practice: I have to document THAT? “Integrated documentation a la Javadoc is both a benefit and a burden” (tags: javadoc)

Tags: javadoc

This entry was posted on Friday, January 30th, 2009 at 3:10 pm and is filed under Teaching. You can follow any responses to this entry through the RSS 2.0 feed. You can leave a response, or trackback from your own site.