Skip to content

ALL-COMM0001 · evidence

This page continues ALL-COMM0001 directly from its source docstring. Read its implementation.

The finding names the file and range of the largest ordinary comment group it measured together with its raw size in the selected measure. The value is that size as a percentage of normalization_max, clipped at one hundred.

A file with no ordinary comment measures zero rather than being skipped, which keeps the value comparable across a repository, and so does a file holding only documentation or its license. Nothing here judges whether a long implementation comment is worth its length, so a rationale and a safety note measure exactly as long as they are. The contextual comment rules say whether they earn it.

  • Cites “Clean Code”, chapter 4
  • Cites “A Philosophy of Software Design”, chapters 12 through 15