Inline Documentation Requirements

Guidelines

  • When you are writing code it is required that all of the following have JSDoc description associated with them:
    • Methods
    • Properties
    • Constructors
    • Classes
    • Interfaces
    • Enumerables (and values)
  • If you modify existing code which does not have required JSDoc information, you must add the JSDoc information.
  • If you modify existing code which has JSDoc information, you must update the information appropriately.
  • If you modify JSDoc information, you must update the associated online documentation. If such online documentation does not exist, you must either:
    • Create full documentation for the class/file you are working on (including existing methods even if you did not create them)
    • Or contact the project leader (Edward Nutting) for further instruction.

Follow the general outline below when writing JSDoc for TypeScript UI:

/** DESCRIPTION LINE - AS SHORT AS POSSIBLE
@param PARAM_NAME PARAM DESCRIPTION : INCLUDE DEFAULT VALUE AND DESCRIPTION OF ALLOWED VALUES.
@returns METHOD_RETURN_VALUE-DESCRIPTION
Notes: ANY NOTES ABOUT THE ITEM - INCLUDE ANY KNOWN/EXPECTED EXCEPTIONS THROWN OR KNOWN ODD/UNEXPECTED BEHAVIOUR
*/

Type specification in JSDoc is not currently required.

Last edited Jun 25, 2013 at 7:16 PM by EdwardNutting, version 4

Comments

No comments yet.