Skip to content

Files

Latest commit

 

History

History
32 lines (25 loc) · 888 Bytes

JavadocConsecutiveEmptyLines.md

File metadata and controls

32 lines (25 loc) · 888 Bytes

Pattern: Empty lines in comment

Issue: -

Description

Checks for javadoc comments with more than one consecutive empty line. Known limitation: Only the first occurrence of consecutive empty lines within a javadoc comment is found.

Example of violations:

/**
 * Description
 *
 *                                                                          // violation
 * @param startIndex - the starting index
 * @return the full count
 * @throws RuntimeException
 *
 * NOTE: Only the first occurrence of consecutive empty lines
 *       within a javadoc comment is found, so the following
 *       lines are not flagged as violations!!!
 *
 *
 */
int countThings(int startIndex) { }

Further Reading