Name | Modified | Size | Downloads / Week |
---|---|---|---|
example | 2013-01-03 | ||
src | 2013-01-03 | ||
PHP_Comment_Reporter.zip | 2013-01-15 | 7.2 kB | |
readme.txt | 2013-01-03 | 1.6 kB | |
Totals: 4 Items | 8.8 kB | 0 |
PHP Comment Reporter Introduction: This is a tool written in PHP to check and report uncommented lines of code in files. Its purpose is to report complex projects and reduce code review time. The tool is capable to traverse complex directories structure, find PHP code and generate report. Why a new tool: There were comment reporting tools available, but they simply state the percentage of commented and uncommented lines. That is not practically useful for devs and code reviewers. This tool will parse each line of code and check for comments. It will finally generate a report marking each uncomment line of code with complete file path. It will also mark files as red flag which are crossing threshold value. This tool will eliminate blank lines and comments while calculating percentage for accuracy purpose Ease of use: The tool is one file of php code , that can be easily integrated with other apps.Simply provide name of file or folder in $scaning_file_name variable and you will get a complete report. Limitation: In single PHP statement, which is wrapped in multiline having double quote, this tool will treat each wrapped line, a new line. For example this mySql: $sql = "UPDATE `key_values` SET `Value_Content` = '" . $this->db->escape($revisionValues['value']) . "', `Comments` = '" . $this->db->escape($revisionValues['comment']) . "', `Is_Active` = '" . $this->db->escape($revisionValues['actstate']) . "', `Is_Modified`='1' WHERE `Value_ID` = '$valueID'";