Поделиться через

Рекомендации по использованию средств анализа кода

  • Статья

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

Рекомендовано

  • Ознакомиться с категориями предупреждений.

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

  • Проводить анализ существующего кода.

    В зависимости от типа проекта, ресурсов и требований, используйте методику, наиболее соответствующую текущим потребностям.

    • Включить все предупреждения.

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

    • Включить подмножество предупреждений.

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

  • Анализировать код в процессе разработки.

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

  • Отслеживать предупреждения.

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

    Практическое руководство. Создание рабочего элемента для дефекта управляемого кода

    Практическое руководство. Создание рабочего элемента для дефектов кода C/C++

    Практическое руководство. Создание рабочего элемента на основе дефекта в коде Transact-SQL

  • Исправлять предупреждения.

    Устранить предупреждение можно одним из следующих способов.

    • Устранить причину предупреждения, т.е. внести правки в код и протестировать его перед возвратом.

    • Подавить предупреждение, т.е. отключить предупреждение, вызываемое управляемым кодом в определенном месте, при помощи атрибута System.Diagnostics.CodeAnalysis.SuppressMessageAttribute.

    • Отключить, т.е. отключить предупреждения для всего управляемого кода на страницах свойств проекта. В C/C++ можно использовать файл заголовка со списком всех предупреждений. Используйте данный файл, чтобы включить предупреждения или отключить предупреждения, которые для проекта не требуются.

    После исправления предупреждения измените его статус с предупреждения на ошибку. Это позволяет обеспечить чистоту кода.

  • Задать требования к возвратам.

    Существует возможность установки политики возврата с требованием об обязательном проведении анализа кода. Можно возвращать только тот код, который успешно проходит анализ. Это обеспечивает чистоту возвращаемого кода. Дополнительные сведения о политике возврата см. в разделе Создание и использование политик возврата с анализом кода.