Name: rm29839 Date: 10/02/97


It would be useful to process a source file and
add a minimal set of comment-lines and tags, if
they are not already present.

The outline could include:
1. Blank comments in the standard form for all
   public classes and methods. (So it would be
   clear where comments are needed.) For example:
   /**
    *
    */
 
2. Blank @author and @version tags for classes.

3. Preliminary @param and @return tags for methods.

4. The @exception tags for any method throwing an
   exception, properly sorted.

5. @see tags for any methods that match a signature
   for an implemented interface. This single feature
   would be priceless. Because (a) the reason for
   a method would be automatically documented, at
   some level of abstraction (a. satisfies the xxxx
   interface") and (b) It means that the interface
   can be a focal point for the documentation. If
   the interface documentation is sufficient, then
   the implementation comment doesn't have to reiterate
   it.

(This would be a fun filter to write.)
company - JavaSoft , email - ###@###.###
======================================================================