Comments
As much as possible, the language used for comments must be English.
Inline Comments
Inline comments must be written in // and must be placed above the line they refer to.
Block Comments
Block comments must be written in /* */ and must be placed above the block they refer to.
Example
// This is an inline comment
/*
* This is a block comment
*/
Block Comments for Methods
Block comments for methods must contain at least the following:
A description of the method
A description of the parameters
A description of the return value, if any
/**
* This is a block comment for a method
*
* @param {string} param1 This is the first parameter
* @param {string} param2 This is the second parameter
* @returns {string} This is the return value
*/
Last modified: 21 December 2023