Download the PHP package savinmikhail/comments-density without Composer
On this page you can find all versions of the php package savinmikhail/comments-density. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download savinmikhail/comments-density
More information about savinmikhail/comments-density
Files in savinmikhail/comments-density
Package comments-density
Short Description CommentDensityAnalyzer is a tool designed to analyze the comment density and quality in source code files in php. It helps maintain and improve the quality of code documentation by evaluating different types of comments and providing insights into their effectiveness and appropriateness.
License MIT
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package comments-density
Comments Density Analyzer
The Comments Density Analyzer is a tool to help you monitor and manage comments in your codebase.
Why Use It?
- Control TODOs and FIXMEs in CI/CD: Ensure these comments are not proliferating unchecked in your codebase.
- Spot Problematic Comments: Identify regular comments explaining "shitty code" or remnants of commented-out code.
- Enforce Documentation Standards: Require docblocks for classes and methods to maintain clear, consistent documentation.
All of this is made possible with a powerful plugin system (see the documentation for examples).
Features
- Multiple Comment Types: Detect and analyze regular comments, docblocks, TODOs, FIXMEs, and license headers.
- Plugin Support: Extend functionality by creating custom plugins via a simple interface.
- Detailed Reporting: Quickly identify areas of your code that need attention.
- Thresholds and Exit Codes: Set thresholds for comment types and return an exit code when they are exceeded.
- Configurable Reports: Output results to the console or as an HTML report.
- Baseline Support: Filter out known technical debt using a baseline file and focus on new issues.
Output Example
Installation
Install Comments Density Analyzer as a development dependency via Composer:
Usage
Analyze the comments in your PHP files:
Generate a baseline to ignore existing technical debt:
Configuration
During installation, the tool can generate a default configuration file. Customize your analysis by editing the comments_density.php file:
Acknowledgments
This project was inspired by Yegor Bugayenko. See Open Source Ideas.
Contributing
Contributions are always welcome! Feel free to submit a pull request with improvements or new features.
License
This library is licensed under the MIT License.
All versions of comments-density with dependencies
ext-tokenizer Version *
composer-plugin-api Version ^2.0
composer/composer Version ^2.8
composer/xdebug-handler Version ^3.0.5
nikic/php-parser Version ^5.1
savinmikhail/primitive_wrappers Version ^1.2
symfony/cache Version ^7.2
symfony/cache-contracts Version ^3.5
symfony/console Version ^6.4 || ^7.0