Project

commentval

0.0
No commit activity in last 3 years
No release in over 3 years
This gem will check if there the code has sufficient amount of comments. This can be used in tools such as Jenkins to check if the comment meets the expected quantity.
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
 Dependencies

Runtime

>= 1.3.15
 Project Readme

Comment Validator

This is a gem which will read the comments from files and check if they meet the targeted percentage.

How to use?

commentval <folders (seperate by comma)> <file extnesions (seperate by comma)> <comment threshold>

Example:

commentval propertyfrontend/ .py 0.9

How does it check for a comment?

It checks if there is either a # or a // in the file. If one of this is found this will count as a comment.