comment-review-criteria

Code comments should explain constraints and correctness factors rather than unnecessary design rationale. This standard helps maintain source code clarity by ensuring comments provide informative, actionable context for reviewers.

Apply a comment-review policy during code reviews to flag violations such as LLM traces, redundant explanations, and historical implementation notes. This detects non-informative comments across multiple languages and projects.

Yes, the comment review criteria applies to multiple languages and projects. It defines metadata and operational guidelines to enforce consistent, correctness-focused commenting practices across diverse codebases.

The best way to enforce static analysis for code comments is to define what constitutes acceptable explanations versus violations. Establish operational guidelines to flag design rationale and LLM traces to improve maintainability.

Code comment quality affects maintainability because non-informative comments obscure correctness factors. Establishing a standard for acceptable explanations versus violations prevents misaligned comments from degrading source code clarity.

You should not use design rationale in source code comments when it does not directly explain constraints or correctness factors. Comment review flags these as violations alongside LLM traces and historical implementation notes.