Плотность комментариев модуля ниже заданного порога
Polyspace ® вычисляет процент плотности комментариев файла, беря отношение комментариев к числу исполняемых строк в файле и затем умножая отношение на 100. Например, плотность комментариев20 указывает, что файл содержит 20% комментариев и 80% инструкций кода. Этот дефект возникает, когда плотность комментариев падает ниже указанного порога. Дополнительные сведения о том, как Polyspace вычисляет плотность комментариев, см. в разделе Comment Density
В Полиспейсе используется пороговое значение по умолчанию 80, если не указано пороговое значение. Использовать Set checkers by file (-checkers-selection-file) для указания файла выбора, в котором можно задать пороговое значение. См. Снижение сложности программного обеспечения с помощью средств проверки в полиспейсе.
При импорте комментариев из предыдущих анализов с помощью polyspace-comments-import, Polyspace копирует любую информацию о проверке в метрике кода Comment Density в предыдущем результате для этой проверки в текущем результате. Если текущий результат содержит ту же метрику кода, информация проверки также копируется в метрику кода.
Нарушение этой проверки может указывать на то, что:
Модуль не документирован должным образом.
Модуль слишком длинный и плотный.
Модуль может содержать непредвиденную или незапланированную разработку.
Эти факторы затрудняют обслуживание и отладку модуля.
Чтобы устранить этот дефект:
Поместите дополнительные комментарии между инструкциями, которые передают намерения разработчика.
Либо уменьшите количество операторов в модуле. Если модуль содержит несколько функций, рассмотрите возможность разделения модуля и документирования их отдельно.
Чтобы исправить эту проверку, выполните рефакторинг кода или измените порог проверки. Передовой практикой является проверка сложности модуля на ранних этапах разработки, чтобы избежать дорогостоящего рефакторинга после разработки.
| Группа: Сложность программного обеспечения |
| Язык: C | C++ |
Акроним:
SC02
|
| Порог по умолчанию: 20 |