You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
You might want to use it to control in CI/CD spreading of todos and fixmes in the codebase.
19
+
The **Comments Density Analyzer** is a tool to help you monitor and manage comments in your codebase.
19
20
20
-
Or you might want to spot simple (regular) comments, which might be there to explain some shitty code or be the commented out code
21
+
### Why Use It?
21
22
22
-
Or you might want to enforce some docblocks (I worked in companies, where each class and method were required to have docblock explaining purpose et al.)
23
+
-**Control TODOs and FIXMEs in CI/CD**: Ensure these comments are not proliferating unchecked in your codebase.
24
+
-**Spot Problematic Comments**: Identify regular comments explaining "shitty code" or remnants of commented-out code.
25
+
-**Enforce Documentation Standards**: Require docblocks for classes and methods to maintain clear, consistent documentation.
23
26
24
-
All of this is possible by utilizing plugins system (see example in docs)
27
+
All of this is made possible with a powerful **plugin system** (see the documentation for examples).
25
28
26
29
## Features
27
30
28
-
-**Multiple Comment Types**: Supports identification and analysis of several comment types including regular,
29
-
docblocks, TODOs, FIXMEs, and license information.
30
-
-**Detailed Reporting**: Quickly find code spots where changes might be necessary.
31
-
-**Quality Check**: Set up a configuration file, and if thresholds aren't met, the exit code will be returned with the report.
32
-
-**Configurable Reports**: Get results in either console or HTML file.
33
-
-**Baseline**: Filter collected comments against a baseline to ignore old technical debt and focus on new issues.
34
-
-**Plugins**: You can implement any logic for processing found comments in your plugins via simple interface
31
+
-**Multiple Comment Types**: Detect and analyze regular comments, docblocks, TODOs, FIXMEs, and license headers.
32
+
-**Plugin Support**: Extend functionality by creating custom plugins via a simple interface.
33
+
-**Detailed Reporting**: Quickly identify areas of your code that need attention.
34
+
-**Thresholds and Exit Codes**: Set thresholds for comment types and return an exit code when they are exceeded.
35
+
-**Configurable Reports**: Output results to the console or as an HTML report.
36
+
-**Baseline Support**: Filter out known technical debt using a baseline file and focus on new issues.
35
37
36
-
### Output Example
38
+
### Output Example
37
39

38
40
39
-
### Installation
41
+
---
42
+
43
+
## Installation
40
44
41
-
To install Comment Density Analyzer, run the following command in your terminal:
45
+
Install **Comments Density Analyzer** as a development dependency via Composer:
0 commit comments