Slick V3.3 manual Javadoc Format, XMLdoc Format

Creating Doc Comments

Javadoc Format

To use the Javadoc commenting format, select the start characters /** and use style @param. Check In- sert leading *. Using the following code sample:

/**[CURSOR_HERE]*/

int setDimensions(int length, int width, int height) {

...

}

Pressing Enter at the "cursor here" location results in the following automatic completion:

/**

*[CURSOR_HERE]

*@param length

*@param width

*@param height

*@return int

*/

int setDimensions(int length, int width, int height) {

...

}

XMLdoc Format

To use the XMLdoc comment format, select the start characters /// and the <param> style. Using the fol- lowing code sample:

///[CURSOR_HERE]

int setDimensions(int length, int width, int height) {

...

}

Pressing Enter at the "cursor here" location results in the following automatic completion:

///<summary>

///[CURSOR_HERE]

///</summary>

///<param name="length"></param>

///<param name="width"></param>

///<param name="height"></param>

///<returns>int</returns>

int setDimensions(int length, int width, int height) {

...

}

179