Lines of comments in files¶
ID: go/lines-of-comments-in-files Kind: metric Severity: Precision: very-high Tags: - documentation
This metric measures the number of comment lines per file. A low number of comments may indicate files that are difficult to understand due to poor documentation.
Consider if the file needs more documentation. Most files should have at least a comment explaining their purpose.
Jeff Atwood. Avoiding Undocumentation. 2005.
Steve McConnell. Code Complete. 2nd Edition. Microsoft Press. 2004.