ln-610-code-comments-auditor

You can audit code comments by analyzing them across six categories: WHY-not-WHAT, Density, Forbidden Content, Docstrings Quality, Actuality, and Legacy Cleanup. This generates a compliance score per category and lists findings with recommended actions for improving clarity.

Yes, the code comments auditor supports universal application across any programming language. It achieves this by auto-detecting the comment syntax, allowing you to audit docstrings and comments in diverse codebases without manual configuration.

To check for outdated code comments after refactoring, audit the Actuality and Legacy Cleanup categories. This evaluates whether existing comments accurately reflect the current state of the codebase and identifies unhelpful or outdated documentation.

WHY-not-WHAT code comment analysis is an auditing category that evaluates whether comments explain the reasoning behind the code rather than merely restating what the code does. It helps improve code maintainability and clarity for developers.

Yes, you can scan for forbidden content and evaluate code comment density. The auditing process checks comments across six critical categories, providing a compliance score and detailed findings to ensure your documentation adheres to best practices.