Анализ проекта
Last updated
Last updated
Для проектов и процессов существует возможность проверки кода, который запускается кнопкой Анализ на вкладке меню Общие.
Функция анализа позволяет проверить проект/процесс на соответствие стандартам качества и надежности. Для анализа используется набор правил для проверки кода, не связанных с выполнением проекта. Правила основаны на методах автоматизации и учитывают имена переменных и аргументов, пустые последовательности, ограничения пакетов и т. д.
ВАЖНО! Статический анализатор проверяет код без фактического выполнения проекта. Таким образом, анализатор не выявляет ошибок при выполнении или компиляции. Для последнего используется инструмент Отладки.
Для настройки правил анализатора нажмите кнопку Анализ ➝ Настройки на вкладке меню Общие. Откроется окно со списком правил:
Каждое правило имеет свой код, имя, область применения и тип действия, которое будет выводиться в результатах анализа.
Рядом с каждым правилом расположен чекбокс - с его помощью можно включить/отключить правило. Это позволяет настраивать параметры анализа в индивидуальном порядке. Если правило выключено, оно будет проигнорировано при запуске анализа.
В столбце Действие указан тип сообщения, которое будет отображаться на панели Анализ при обнаружении несоответствия правилу:
Ошибка: создает ошибку на панели Анализ.
Предупреждение: создает предупреждение.
Информация: создает сообщение.
Действие для правила можно изменить: нажмите на него в соответствующем столбце и выберите другое значение из выпадающего списка.
С полным списком правил и их параметрами вы можете ознакомиться здесь.
Для запуска анализа кода нажмите кнопку Анализ ➝ Анализировать проект или Анализ ➝ Анализировать процесс. Результат проверки отобразится в нижней части экрана на панели Анализ:
Для запуска анализатора из командной строки используются параметры:
rulepath=<путь к файлу правил>.
projfile=<путь к проекту>.
outputfile=<путь к файлу результатов>.
errlog=<путь к файлу журнала>.
noclose - не закрывать по завершении анализа.
console - вывод в консоль.
output=<json,xml,xlsx> - формат файла результата.
lang=<ru-RU> - язык.
Пример:
Доступна автоматическая проверка синтаксиса, которая работает в фоновом режиме. Настройка является взаимодополняющей: если синтаксис содержит ошибку, на элементе, где она обнаружена, появится иконка предупреждения. При наведении на иконку можно увидеть подробные сведения об ошибке:
Чтобы установить фоновую проверку, перейдите в раздел меню Файл ➝ Настройки ➝ Общие ➝ Отладчик и включите параметр Проверять синтаксис. В выпадающем списке Алгоритм проверки синтаксиса C# выберите нужный вам алгоритм.
С версии 1.24.8 добавлена возможность выбора алгоритма проверки синтаксиса C# в настройках. Теперь пользователи могут переключаться между двумя подходами:
новым алгоритмом на базе библиотек Actipro
классическим алгоритмом, использующим библиотеки Microsoft CodeAnalysis. По умолчанию используется алгоритм Microsoft.
Также существует возможность создавать собственные правила анализа. С инструкцией можно ознакомиться здесь.
При найденном несоответствии будет выведено сообщение, содержащее имя и код правила, название файла, где найдено нарушение, и рекомендация по исправлению. Чтобы развернуть рекомендацию, нажмите на иконку Подробнее .
Результат проверки возможно экспортировать в файл *.xlsx. Выгрузка доступна по кнопке Экспорт в файл в верхней части панели:
