Thread: JavaDoc

Code:

/** Description of class */
class className {
   
   /**  Description of the method
   *    @param b what b is used to determine
   *    @return description of what is returned
   */
   public int doSomething(boolean b)
}

There is another documentation tool for C++, called Doxygen, which is similair to Javadoc. I used it to create the documentation (somewhat sparse, but it's been a solo effort thus far) here for my game.

http://bomberlan.sourceforge.net/html/index.html

Doxygen can be had here

http://www.doxygen.org

Yeah, you literally put @param [name of variable] [description of variable]

As for constants, they are described just like pretty much everything else (with a comment starting with /** before it appears).

Code:

/** Class containing bit packable constants that describe game object movement */
class MovementConstants {

     /** Move the object to the right */
    static final int MOVE_RIGHT = 0x1;

     /** Move the object to the left */
    static final int MOVE_LEFT = 0x2;

    // etc
}