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