Problem
Some object comments start with an article ("A", "An", or "The"), which makes them unnecessarily verbose and inconsistent with technical writing best practices. For example:
The object that calculates sum.
[] +> my-sum
Starting with "The" adds no information. The comment should begin directly with the meaningful word.
Suggestion
Add a new lint comment-starts-with-article that reports a WARNING level defect when the first word of a comment is "A", "An", or "The" (case-insensitive).
Example of bad code
The main entry point.
[] +> app
Expected fix
Main entry point.
[] +> app
Problem
Some object comments start with an article ("A", "An", or "The"), which makes them unnecessarily verbose and inconsistent with technical writing best practices. For example:
The object that calculates sum.
[] +> my-sum
Starting with "The" adds no information. The comment should begin directly with the meaningful word.
Suggestion
Add a new lint
comment-starts-with-articlethat reports aWARNINGlevel defect when the first word of a comment is "A", "An", or "The" (case-insensitive).Example of bad code
The main entry point.
[] +> app
Expected fix
Main entry point.
[] +> app