CRITICAL
Rule Definition
Code maintainability can be improved if there is documentation in the code. This rule will ensure that comments exist in Methods and Functions.
Remediation
Modify the source code to reduce the number of undocumented Methods and Functions.
Violation Code Sample
class CastTest{
var $items;
function add_item($artnr, $num) {
$this->items[$artnr] += $num;
}
}
Fixed Code Sample
class CastTest{
// Item
var $items;
function add_item($artnr, $num) {
// Add of the Item
$this->items[$artnr] += $num;
}
}
Related Technologies
Technical Criterion
Documentation - Volume of Comments
About CAST Appmarq
CAST Appmarq is by far the biggest repository of data about real IT systems. It's built on thousands of analyzed applications, made of 35 different technologies, by over 300 business organizations across major verticals. It provides IT Leaders with factual key analytics to let them know if their applications are on track.