jscs-jsdoc icon indicating copy to clipboard operation
jscs-jsdoc copied to clipboard

New Rule: require summary description.

Open dtracers opened this issue 10 years ago • 0 comments

this is an extension of #106 and #99

Which is that a summary description is required with a new line and a complete sentence.

This actually a stricter version of requiring a new line. But the complete description still can follow under the new line rule. Basically there must be a period at the end of the first line. Which is then followed by a new line.

NOTE This does not require the summary to start with an upper case letter.

examples:

/**
 * Valid summary.
 *
 * Deeper description information
 */
function foo() {
}

/**
 * Invalid summary.  Summary can only be a single sentence
 */
function bar() {
}

/**
 * Invalid summary
 * on two lines.
 */
function foobar() {
}

/**
 * lowercase summary is valid with this rule.
 */
function barfoo() {
}

dtracers avatar May 31 '15 01:05 dtracers