Bad Documentation Comment

Definition:

  • A documentation comment does not conform to its format. Documentation comments like T3Doc need to conform to certain formatting rules and appear at certain positions in the source code.

Code Example:

/**
* This function does something.
* @param imParam a very important parameter
*/
function exampleFunction(integer inParam) {
  // ...
}

References:

Quality attributes

  • - Code Example

  • - Cause and Effect

  • - Frequency

  • - Refactoring