SuiteScript 2.1 JSDoc Comment Blocks

To be recognized as valid JSDoc content, JSDoc tag comment blocks must start with /** and end with */. JSDoc tags consist of a key-value pair. The key is a string starting with the @ symbol and ending with the first white space after this key string. The value starts with the next non-whitespace character and ends with the next carriage return. Each comment line in the block starts with *.

The following table lists examples of valid and invalid JSDoc formatting.

Valid Examples	Invalid Examples
/** * @NApiVersion 2.1 */	/* * @NApiVersion 2.1 */ The JSDoc tag comment block does not start with /**.
	// @NApiVersion 2.1 The JSDoc tag comment is a single-line comment and not a block.
	/** * @NApiVersion 2.1*/ The JSDoc tag comment block does not include a carriage return after the value.

Related Topics

• SuiteScript 2.1 JSDoc Validation
• SuiteScript 2.1 JSDoc Tags

General Notices