no-blank-block-descriptions.md

no-blank-block-descriptions

If tags are present, this rule will prevent empty lines in the block description.

If no tags are present, this rule will prevent extra empty lines in the block description.

Fixer

(TODO)

Context and settings

Context	everywhere
Tags	(Block description)
Recommended	false
Settings
Options

Failing examples

The following patterns are considered problems:

/**
 *
 * @param {number} x
 */
function functionWithClearName(x) {}
// Message: There should be no blank lines in block descriptions followed by tags.

/**
 *
 *
 */
function functionWithClearName() {}
// Message: There should be no extra blank lines in block descriptions not followed by tags.

Passing examples

The following patterns are not considered problems:

/**
 * Non-empty description
 * @param {number} x
 */
function functionWithClearName(x) {}

/**
 * @param {number} x
 */
function functionWithClearName(x) {}

/**
 *
 */
function functionWithClearName() {}

/**
 */
function functionWithClearName() {}

/** */
function functionWithClearName() {}

/** Some desc. */
function functionWithClearName() {}

/** @someTag */
function functionWithClearName() {}