Метрики качества кода

Примечание

В этом разделе описывается веб-интерфейс Polyspace Metrics.

Для более простых совместных обзоров используйте Polyspace^® Code Prover™ Access™. В дополнение к более интуитивно понятной веб-приборной панели, с Polyspace Access можно:

Просмотрите и разъясните результаты непосредственно из веб-браузера.
Интеграция инструмента отслеживания дефектов, такого как Jira, с веб-интерфейсом и создание билетов для отслеживания результатов Polyspace.
Делитесь результатами анализа с помощью веб- ссылок.

Для получения дополнительной информации см. документацию Polyspace Code Prover Access.

Polyspace Metrics - это веб-панель мониторинга, которая генерирует метрики качества кода из результатов вашей верификации. Используя эту инструментальную панель, можно:

Предоставьте вашему руководству высокоуровневый обзор качества вашего кода.
Сравните качество кода с предопределенными стандартами.
Установите процесс, в котором вы подробно просматриваете только те результаты, которые не соответствуют стандартам.
Отслеживайте улучшения или регрессию в качестве кода с течением времени.

Для каждого проекта или запуска можно просмотреть метрики качества кода, распределенные по четырем вкладкам, на уровне проекта, файла и функции.

Вкладка Summary предоставляет высокоуровневый обзор результатов верификации.
Вкладка Code Metrics содержит подробные сведения о метриках сложности кода в результатах.
См. «Метрики кода».
Вкладка Coding rules содержит подробную информацию о нарушениях правил кодирования в результатах.
См. «Стандарты кодирования».
Вкладка Run-Time Checks содержит подробные сведения о проверке результатов во время выполнения.
См. «Проверки во время выполнения».

Если вы включаете Software Quality Targets, каждая вкладка также определяет, как ваш проект или запуск сравнивается с этими целями. См. Сравнение метрик с целями качества программного обеспечения.

Вкладка Сводка

На вкладке Summary приводятся результаты верификации для проекта или запуска.

Чтобы увидеть результаты, встроенные в исходный код, загрузите результаты из Polyspace Metrics в пользовательский интерфейс. Для получения дополнительной информации см. «Просмотр метрик для конкретного проекта» или «Запуск».

Имя столбца		Описание
Verification Status		Завершен уровень верификации. См. `Verification level (-to)`.
Code Metrics	Files	Количество файлов в проекте.
Code Metrics	Lines of code	Количество строк кода, с разбивкой по файлам.
Coding Rules	Confirmed Defects	Количество нарушений правил кодирования, которым вы присваиваете Severity `High`, `Medium` или `Low` в пользовательском интерфейсе Polyspace. Смотрите Адрес Результаты Polyspace через исправления ошибок или обоснования.
Coding Rules	Violations	Общее количество нарушений правил кодирования.
Run-Time Errors	Confirmed Defects	Количество проверок во время выполнения, которым вы присваиваете Severity `High`, `Medium` или `Low` в пользовательском интерфейсе Polyspace. Смотрите Адрес Результаты Polyspace через исправления ошибок или обоснования.
Run-Time Errors	Run-Time Reliability	Мера качества вашего кода, выраженная в процентах. Процент вычисляется как количество зеленых и других обоснованных проверок, разделенных на общее количество проверок. Для обоснования проверки в пользовательском интерфейсе Polyspace необходимо назначить соответствующее Status. Смотрите Адрес Результаты Polyspace через исправления ошибок или обоснования.
Software Quality Objectives	Overall Status	Статус PASS или FAIL зависит от того, удовлетворяет ли ваш код заданным вами целям качества программного обеспечения. Для получения дополнительной информации смотрите Сравнение метриков с целями качества программного обеспечения.
	Level	Заданные вами цели качества программного обеспечения. Можно либо использовать предопределенный набор целей, либо задать свои собственные цели. См.: Цели качества программного обеспечения Настройка целей качества программного обеспечения
	Review Progress	Мера вашего прогресса обзора, выраженная в процентах. Этот процент рассчитывается как количество проверенных «неэкранированных» проверок и нарушений правил кодирования, разделенных на общее количество «неэкранированных» проверок и нарушений правил. Чтобы просмотреть проверку, в пользовательском интерфейсе Polyspace необходимо назначить Status. Смотрите Адрес Результаты Polyspace через исправления ошибок или обоснования.
	Justified Code Metrics	Процент обоснованных нарушений порога метрики кода. Чтобы обосновать нарушение порога, в пользовательском интерфейсе Polyspace необходимо назначить соответствующее Status. Смотрите Адрес Результаты Polyspace через исправления ошибок или обоснования.
	Justified Coding Rules	Процент оправданных нарушений правил кодирования. Чтобы обосновать нарушение правил, в пользовательском интерфейсе Polyspace необходимо назначить соответствующее Status. Смотрите Адрес Результаты Polyspace через исправления ошибок или обоснования.
	Justified Run-Time Errors	Процент обоснованных проверок во время выполнения. Для обоснования проверки в пользовательском интерфейсе Polyspace необходимо назначить соответствующее Status. Смотрите Адрес Результаты Polyspace через исправления ошибок или обоснования.

Вкладка «Метрики кода»

На вкладке Code Metrics перечислены метрики сложности кода для вашего проекта или запуска.

Некоторые метрики вычисляются на уровне проекта, другие вычисляются на уровне файла или функции. Для метрик, вычисленных на уровне функции, запись, отображаемая для файла, является либо агрегированной, либо максимальной по сравнению с функциями в файле.

Для получения дополнительной информации см. Раздел «Метрики кода».

Вкладка Правила кодирования

На вкладке Coding Rules перечислены нарушения правил кодирования в проекте или запуске. Для получения дополнительной информации о правилах кодирования смотрите Стандарты кодирования.

Можно сгруппировать информацию в столбцы по Files или Coding Rules.

Имя столбца		Описание
Coding Rules	Confirmed Defects	Количество нарушений правил кодирования, которым вы присваиваете Severity `High`, `Medium`, или `Low` в пользовательском интерфейсе Polyspace. Смотрите Адрес Результаты Polyspace через исправления ошибок или обоснования.
	Justified	Количество обоснованных нарушений правил кодирования. Чтобы обосновать нарушение правил, в пользовательском интерфейсе Polyspace назначьте соответствующее Status. Смотрите Адрес Результаты Polyspace через исправления ошибок или обоснования.
	Violations	Общее количество нарушений правил кодирования.
Software Quality Objectives	Quality Status	Статус PASS или FAIL зависит от того, удовлетворяет ли ваш код заданным вами целям качества программного обеспечения. См. Сравнение метрик с целями качества программного обеспечения.
	Level	Заданные вами цели качества программного обеспечения. Можно либо использовать предопределенный набор целей, либо задать свои собственные цели. См.: Цели качества программного обеспечения Настройка целей качества программного обеспечения
	Review Progress	Мера вашего прогресса обзора, выраженная в процентах. Процент вычисляется как количество рассмотренных нарушений правил кодирования, разделенное на общее количество нарушений. Чтобы пометить проверяемую проверку, в пользовательском интерфейсе Polyspace присвойте Status чеку. Смотрите Адрес Результаты Polyspace через исправления ошибок или обоснования.

Вкладка Проверки во время выполнения

На вкладке Run-Time Checks перечислены проверки во время выполнения в проекте или запуске. Дополнительные сведения о проверках см. в разделе Проверки во время выполнения.

Можно сгруппировать информацию в столбцы по Files или Run-Time Categories.

Имя столбца		Описание
Confirmed Defects		Количество проверок во время выполнения, которым вы присваиваете Severity `High`, `Medium`, или `Low` в пользовательском интерфейсе Polyspace. Смотрите Адрес Результаты Polyspace через исправления ошибок или обоснования.
Run-Time Selectivity		Процент, рассчитанный как количество неоранжевых проверок, разделенных на общее количество проверок.
Green Code	Checks	Количество зеленых проверок. Смотрите Результаты Code Prover и Цвета исходного кода.
Systematic Run-Time Errors (Red Checks)	Justified	Процент красных проверок, которые вы обосновали. Для обоснования проверки в пользовательском интерфейсе Polyspace присвойте соответствующее Status. Смотрите Адрес Результаты Polyspace через исправления ошибок или обоснования.
Systematic Run-Time Errors (Red Checks)	Checks	Количество красных проверок. Смотрите Результаты Code Prover и Цвета исходного кода.
Unreachable Branches (Gray Checks)	Justified	Процент серых проверок, которые вы обосновали. Для обоснования проверки в пользовательском интерфейсе Polyspace присвойте соответствующее Status. Смотрите Адрес Результаты Polyspace через исправления ошибок или обоснования.
Unreachable Branches (Gray Checks)	Checks	Количество серых проверок. Смотрите Результаты Code Prover и Цвета исходного кода.
Other Run-Time Errors (Orange Checks)	Justified	Процент оранжевых проверок, которые вы обосновали. Для обоснования проверки в пользовательском интерфейсе Polyspace присвойте соответствующее Status. Смотрите Адрес Результаты Polyspace через исправления ошибок или обоснования.
	Checks	Количество оранжевых проверок. Смотрите Результаты Code Prover и Цвета исходного кода.
	Path-Related Issues	Количество оранжевых проверок, указывающих на ошибку времени выполнения только на определенных путях выполнения. Смотрите Критические оранжевые проверки.
	Bounded-Input Issues	Количество оранжевых проверок, которые указывают на ошибку времени выполнения только для определенных входов. На входах заданы внешние ограничения. Смотрите Критические оранжевые проверки.
	Unbounded-Input Issues	Количество оранжевых проверок, которые указывают на ошибку времени выполнения только для определенных входов. Вы не указали никаких внешних ограничений на входы. Смотрите Критические оранжевые проверки.
Non-terminating constructs	Justified	Процент не оконечных конструкций, которые вы обосновали. Для обоснования проверки в пользовательском интерфейсе Polyspace присвойте соответствующее Status. Смотрите Адрес Результаты Polyspace через исправления ошибок или обоснования.
Non-terminating constructs	Checks	Количество неоконечных конструкций, таких как `Non-terminating call` или `Non-terminating loop`.
Software Quality Objectives	Quality Status	Статус PASS или FAIL зависит от того, удовлетворяет ли ваш код заданным вами целям качества программного обеспечения. См. Сравнение метрик с целями качества программного обеспечения.
	Level	Заданные вами цели качества программного обеспечения. Можно либо использовать предопределенный набор целей, либо задать свои собственные цели. См.: Цели качества программного обеспечения Настройка целей качества программного обеспечения
	Review Progress	Мера вашего прогресса обзора, выраженная в процентах. Процент вычисляется как количество проверенных проверок, разделенных на общее количество проверок. Чтобы пометить проверяемую проверку, в пользовательском интерфейсе Polyspace присвойте Status чеку. Смотрите Адрес Результаты Polyspace через исправления ошибок или обоснования.

Документация