Найти ошибку в программе c
Я занимаюсь разработкой и когда пишу код, то он иногда не работает так, как я задумывал или даже вообще не работает. Сижу и смотрю на него, гадаю: что и где не так?
Не могу усидеть - иду сразу на ресурсы профессионалов, например Stack Overflow и публикую вопрос "Где здесь ошибка?" или "Почему не работает?"
Но оказывается часто, что проблема мелкая: дурацкая опечатка, ошибка в синтаксисе или еще какая мелочь. Профессионалом так не станешь, если по каждой ерунде бегать по ресурсам. А я хочу им быть.
Ну вот зачем здесь эти "Здравствуйте" и "Спасибо"? Чтобы вопрос больше походил на вопрос от нуба что ли?
1 ответ 1
Вчера всё работало, а сегодня не работает / Код не работает как задумано
В чем заключается процесс отладки? Что это такое?
Процесс отладки состоит в том, что мы останавливаем выполнения скрипта в любом месте, смотрим, что находится в переменных, в функциях, анализируем и переходим в другие места; ищем те места, где поведение отклоняется от правильного.
Заметка: Отладка производится как правило в IDE (Интегрированная среда разработки). Что это такое можно чуть подробнее ознакомиться в вопросе
Какие есть способы предупреждения ошибок, их нахождения и устранения?
В данном случае будет рассмотрен пример с Visual Studio, но отладить код можно и в любой другой IDE.
Подготовка
Достаточно иметь в наличии IDE, например Visual Studio
Запуск
Отладка запускается сочетанием F5 или выбором в верхнем меню Debug → Start Debugging
В данном случае, т.к. функция вызывается сразу на той же странице, то при нажатии кнопки Debug — отладчик моментально вызовет метод, выполнение "заморозится" на первом же брейкпойнте. В ином случае, для активации требуется исполнить действие, при котором произойдет исполнение нужного участка кода (клик на кнопку в UI, передача POST запроса с данными и прочие другие действия)
- Стэк вызовов, все вложенные вызовы, которые привели к текущему месту кода.
- Переменные. На текущий момент строки ниже номера 8 ещё не выполнилась, поэтому определена лишь data и numsStringArr
- Показывает текущие значения любых переменных и выражений. В любой момент здесь можно вписать имя любой переменной в поле name и посмотреть её значение в реальном времени. Например data или nums[0] , а можно и nums[i] и item.test.data.name[5].infoНайти ошибку в программе c] и т.д. На текущий момент строки ниже номера 24 ещё не выполнилась, поэтому num (которая появляется лишь в цикле foreach ) во вкладке Watch обозначена красным цветом с надписью "The name 'num' does not exist in the current context".
Процесс
Для самого процесса используются элементы управления (см. изображение выше, выделено зеленым прямоугольником)
Show Next Statement ( Alt+Num * ) — переносит в файл и текущую линию отлаживаемого скрипта. Например если файлов много, решили посмотреть что в других вкладках, а потом забыли где у вас отладка :)
Step Over ( F10 ) — делает один шаг не заходя внутрь функции. Т.е. если на текущей линии есть какая-то функция, а не просто переменная со значением, то при клике данной кнопки, отладчик не будет заходить внутрь неё.
Step Into ( F11 ) — делает шаг. Но в отличие от предыдущей, если есть вложенный вызов (например функция), то заходит внутрь неё.
Step Out ( Shift+F11 ) — выполняет команды до завершения текущей функции. Удобна, если случайно вошли во вложенный вызов и нужно быстро из него выйти, не завершая при этом отладку.
Restart ( Ctrl+Shift+F5 ) — Перезапустить отладку
Continue ( F5 ) — Продолжает выполнения скрипта с текущего момента. Если больше нет других точек останова, то отладка заканчивается и скрипт продолжает работу. В ином случае работа прерывается на следующей точке останова.
Stop Debugging ( Shift+F5 ) — Завершить отладку
Итак, в текущем коде видно значение входного параметра:
- data = "23 24 11 18" — строка с данными через пробел
- numsStringArr = — массив строк, который получился из входной переменной.
Если нажмем F10 2 раза, то окажемся на строке 11; во вкладках Watch и Variables и в самой странице с кодом увидим, что nums была инициализирована и в ней лежит массив целых чисел .
Если теперь нажмем F10 , то попадем внутрь цикла foreach и нажимая теперь F10 пока не окончится цикл, можно будет наблюдать на каждой итерации, как значение num и sum постоянно изменяются. num теперь можно будет наблюдать во вкладке Watch , потому что сейчас она доступна внутри цикла. Тем самым мы можем проследить шаг за шагом весь процесс изменения любых переменных и значений на любом этапе, который интересует.
Дальнейшие нажатия F10 переместит линию кода на строки 15, 16 и, наконец, 20.
Дополнительно
Если перейти во вкладку Breakpoints в нижней панели, то можно посмотреть все брейкпойнты, удалить все брейкпойнты, включить/выключить, а также еще более тонко настроить условие, при котором на данной отметке надо остановиться. В методе выше, например, нужно остановиться только когда sum превысит значение 20.
Это удобно, если останов нужен только при определённом значении, а не всегда (особенно в случае с циклами).
Переменная errno и коды ошибок
errno – переменная, хранящая целочисленный код последней ошибки. В каждом потоке существует своя локальная версия errno, чем и обусловливается её безопасность в многопоточной среде. Обычно errno реализуется в виде макроса, разворачивающегося в вызов функции, возвращающей указатель на целочисленный буфер. При запуске программы значение errno равно нулю.
Стандарт ISO C определяет следующие коды:
- EDOM – (Error domain) ошибка области определения.
- EILSEQ – (Error invalid sequence) ошибочная последовательность байтов.
- ERANGE – (Error range) результат слишком велик.
Нехитрый скрипт печатает в консоль коды ошибок, их символические имена и описания:
Если вызов функции завершился ошибкой, то она устанавливает переменную errno в ненулевое значение. Если же вызов прошёл успешно, функция обычно не проверяет и не меняет переменную errno. Поэтому перед вызовом функции её нужно установить в 0 .
Как видите, описания ошибок в спецификации функции iconv() более информативны, чем в .
Функции работы с errno
Получив код ошибки, хочется сразу получить по нему её описание. К счастью, ISO C предлагает целый набор полезных функций.
void perror(const char *s);
strerror() не безопасная функция. Во-первых, возвращаемая ею строка не является константной. При этом она может храниться в статической или в динамической памяти в зависимости от реализации. В первом случае её изменение приведёт к ошибке времени выполнения. Во-вторых, если вы решите сохранить указатель на строку, и после вызовите функцию с новым кодом, все прежние указатели будут указывать уже на новую строку, ибо она использует один буфер для всех строк. В-третьих, её поведение в многопоточной среде не определено в стандарте. Впрочем, в QNX она объявлена как thread safe.
Поэтому в новом стандарте ISO C11 были предложены две очень полезные функции.
size_t strerrorlen_s(errno_t errnum);
Возвращает длину строки с описанием ошибки errnum .
errno_t strerror_s(char *buf, rsize_t buflen, errno_t errnum);
Копирует строку с описание ошибки errnum в буфер buf длиной buflen .
Функции входят в Annex K (Bounds-checking interfaces), вызвавший много споров. Он не обязателен к выполнению и целиком не реализован ни в одной из свободных библиотек. Open Watcom C/C++ (Windows), Slibc (GNU libc) и Safe C Library (POSIX), в последней, к сожалению, именно эти две функции не реализованы. Тем не менее, их можно найти в коммерческих средах разработки и системах реального времени, Embarcadero RAD Studio, INtime RTOS, QNX.
Стандарт POSIX.1-2008 определяет следующие функции:
char *strerror_l(int errnum, locale_t locale);
Возвращает строку, содержащую локализованное описание ошибки errnum , используя locale . Безопасна в многопоточной среде. Не реализована в Mac OS X, FreeBSD, NetBSD, OpenBSD, Solaris и прочих коммерческих UNIX. Реализована в Linux, MINIX 3 и Illumos (OpenSolaris).
int strerror_r(int errnum, char *buf, size_t buflen);
Копирует строку с описание ошибки errnum в буфер buf длиной buflen . Если buflen меньше длины строки, лишнее обрезается. Безопасна в многоготочной среде. Реализована во всех UNIX.
Увы, никакого аналога strerrorlen_s() в POSIX не определили, поэтому длину строки можно выяснить лишь экспериментальным путём. Обычно 300 символов хватает за глаза. GNU C Library в реализации strerror() использует буфер длиной в 1024 символа. Но мало ли, а вдруг?
Макрос assert()
Макрос, проверяющий условие expression (его результат должен быть числом) во время выполнения. Если условие не выполняется ( expression равно нулю), он печатает в stderr значения __FILE__ , __LINE__ , __func__ и expression в виде строки, после чего вызывает функцию abort() .
Если макрос NDEBUG определён перед включением , то assert() разворачивается в ((void) 0) и не делает ничего. Используется в отладочных целях.
Функции atexit(), exit() и abort()
int atexit(void (*func)(void));
Регистрирует функции, вызываемые при нормальном завершении работы программы в порядке, обратном их регистрации. Можно зарегистрировать до 32 функций.
_Noreturn void exit(int exit_code);
Главное преимущество exit() в том, что она позволяет завершить программу не только из main() , но и из любой вложенной функции. К примеру, если в глубоко вложенной функции выполнилось (или не выполнилось) некоторое условие, после чего дальнейшее выполнение программы теряет всякий смысл. Подобный приём (early exit) широко используется при написании демонов, системных утилит и парсеров. В интерактивных программах с бесконечным главным циклом exit() можно использовать для выхода из программы при выборе нужного пункта меню.
_Noreturn void abort(void);
Вызывает аварийное завершение программы, если сигнал не был перехвачен обработчиком сигналов. Временные файлы не уничтожаются, закрытие потоков определяется реализацией. Самое главное отличие вызовов abort() и exit(EXIT_FAILURE) в том, что первый посылает программе сигнал SIGABRT , его можно перехватить и произвести нужные действия перед завершением программы. Записывается дамп памяти программы (core dump file), если они разрешены. При запуске в отладчике он перехватывает сигнал SIGABRT и останавливает выполнение программы, что очень удобно в отладке.
Вывод в отладчике:
В случае критической ошибки нужно использовать функцию abort() . К примеру, если при выделении памяти или записи файла произошла ошибка. Любые дальнейшие действия могут усугубить ситуацию. Если завершить выполнение обычным способом, при котором производится сброс потоков ввода — вывода, можно потерять ещё неповрежденные данные и временные файлы, поэтому самым лучшим решением будет записать дамп и мгновенно завершить программу.
В случае же некритической ошибки, например, вы не смогли открыть файл, можно безопасно выйти через exit() .
Функции setjmp() и longjmp()
Вот мы и подошли к самому интересному – функциям нелокальных переходов. setjmp() и longjmp() работают по принципу goto, но в отличие от него позволяют перепрыгивать из одного места в другое в пределах всей программы, а не одной функции.
int setjmp(jmp_buf env);
Сохраняет информацию о контексте выполнения программы (регистры микропроцессора и прочее) в env . Возвращает 0 , если была вызвана напрямую или value , если из longjmp() .
void longjmp(jmp_buf env, int value);
Восстанавливает контекст выполнения программы из env , возвращает управление setjmp() и передаёт ей value .
Используя setjmp() и longjmp () можно реализовать механизм исключений. Во многих языках высокого уровня (например, в Perl) исключения реализованы через них.
Внимание! Функции setjmp() и longjmp () в первую очередь применяются в системном программировании, и их использование в клиентском коде не рекомендуется. Их применение ухудшает читаемость программы и может привести к непредсказуемым ошибкам. Например, что произойдёт, если вы прыгните не вверх по стеку – в вызывающую функцию, а в параллельную, уже завершившую выполнение?
Visual Studio включает эффективный интегрированный набор средств сборки и отладки проектов. Из этой статьи вы узнаете, как Visual Studio может помочь обнаружить проблемы в коде с помощью построения выходных данных, анализа кода, средств отладки и модульных тестов.
Мы разобрались, как работать с редактором, и написали код. Теперь необходимо убедиться, что код работает должным образом. Отладка в Visual Studio, как и в большинстве интегрированных сред разработки (IDE), осуществляется в два этапа: построение кода для обнаружения и устранения ошибок проекта и компилятора и выполнение кода для обнаружения ошибок времени выполнения и динамических ошибок.
Сборка кода
Существует два основных типа конфигурации сборки: отладка и выпуск. При использовании конфигурации отладка создается более крупный и медленный исполняемый файл, обеспечивающий более широкие интерактивные возможности отладки во время выполнения. Исполняемый файл конфигурации отладка никогда не следует отправлять. Конфигурация выпуск позволяет создать более быстрый оптимизированный исполняемый файл, подходящий для отправки (по крайней мере с точки зрения компилятора). По умолчанию используется конфигурация Отладка.
Самый простой способ выполнить сборку проекта — нажать клавишу F7, однако вы также можете начать сборку, выбрав в главном меню пункты Сборка > Собрать решение.
Процесс сборки можно наблюдать в окне Вывод в нижней части пользовательского интерфейса Visual Studio. Здесь отображаются ошибки, предупреждения и операции сборки. При наличии ошибок (или предупреждений выше заданного уровня) сборка завершится ошибкой. Можно щелкнуть ошибку и предупреждение, чтобы перейти к строке, где они возникли. Для перестроения проекта можно нажать клавишу F7 (чтобы перекомпилировать только файлы с ошибками) или CTRL+ALT+F7 (для чистого полного перестроения).
После успешного выполнения построения вы увидите примерно следующие результаты в окне Вывод:
Просмотр списка ошибок
Если вы внесли какие-либо изменения в код, который был ранее и успешно скомпилирован, возможно, возникнет ошибка. Если вы новичок в написании кода, возможно, их будет много. Ошибки иногда очевидны, например простая синтаксическая ошибка или неправильное имя переменной, а иногда их причину трудно выяснить, имея в распоряжении только зашифрованный код. Чтобы получить более четкое представление о проблеме, перейдите вниз окна Вывод сборки и щелкните вкладку Список ошибок. При этом вы перейдете к более организованному представлению ошибок и предупреждений для проекта и получите доступ к некоторым дополнительным параметрам.
Щелкните строку ошибки в окне Список ошибок, чтобы перейти в строку кода, в которой возникла ошибка. (Кроме того, номера строк можно включить, нажав клавиши Ctrl+Q, введя номера строк, а затем выбрав Включить или отключить отображение номеров строк в результатах. Это самый быстрый способ перехода в диалоговое окно Параметры, где можно включить номера строк.
Нажмите клавиши CTRL+G для быстрого перехода к номеру строки, в которой возникла ошибка.
Ошибку можно узнать по подчеркиванию красной волнистой линией Чтобы получить дополнительные сведения, наведите на нее указатель мыши. Внесите исправления, и подчеркивание исчезнет, хотя в результате исправления может возникнуть новая ошибка (это называется "регрессия").
Пройдите список ошибок и устраните все ошибки в коде.
Просмотр подробных сведений об ошибках
Многие ошибки трудны для восприятия, будучи представленными в терминах компилятора. В этом случае могут потребоваться дополнительные сведения. Из окна Список ошибок можно выполнить автоматический поиск в поисковой системе Bing для получения дополнительных сведений об ошибке или предупреждении. Щелкните правой кнопкой мыши по соответствующей строке записи и выберите Показать справочные сведения об ошибке из контекстного меню или щелкните гиперссылку с кодом ошибки в столбце код в списке ошибок.
В зависимости от настроек результаты поиска по коду и описанию ошибки откроются в веб-браузере либо во вкладке Visual Studio с результатами поиска Bing. Представленные результаты — из различных источников в Интернете, и, возможно, не все они будут полезными.
Анализ кода
Средства анализа выполняют поиск общих проблем в коде, которые могут привести к ошибкам времени выполнения или проблемам управления кодом.
Анализ кода C++
Чтобы выполнить анализ кода C++, запустите статический анализ кода. Запустить этот компонент после устранения всех очевидных ошибок, препятствующих успешной сборке, и потратить некоторое время, чтобы устранить создаваемые им предупреждения, — очень полезная привычка. Вы сможете избавиться от определенных будущих проблем, а также научитесь некоторым полезным приемам написания кода.
Нажмите клавиши ALT+F11 (или выберите в верхнем меню команду Анализ > Выполнить анализ кода в решении) для запуска статического анализа кода.
Все новые или обновленные предупреждения отображаются на вкладке Список ошибок в нижней части интегрированной среды разработки. Щелкните предупреждение для перехода к нему в коде.
Использование быстрых действий для исправления или рефакторинга кода
Если вы привыкли работать с клавиатурой, вы можете использовать клавиши со стрелками и сочетание клавиш CTRL+ . для проверки возможностей оптимизации и очистки кода!
Запуск очистки кода
Помимо форматирования пробелов, отступов и т. п., функция Очистка кода применяет определенные вами соглашения о стиле кода. Ваши настройки для каждого стиля кода считываются из файла EditorConfig, если такой существует в проекте, или из раздела Параметры стиля кода, который доступен через диалоговое окно Параметры.
Отладка выполняемого кода
Успешно завершив сборку кода и его очистку, запустите код, нажав клавишу F5 или выбрав команду Отладка > Начать отладку. Приложение будет запущено в среде отладки, и вы сможете пронаблюдать его поведение. Интегрированная среда разработки Visual Studio изменяется во время выполнения приложения: окно Вывод заменяется двумя новыми окнами (в конфигурации окон по умолчанию): окном с вкладками Видимые/Локальные/Контрольные значения и окном с вкладками Стек вызовов/Точки останова/Параметры исключений/Вывод. Эти окна имеют несколько вкладок, которые позволяют просмотреть и проверить переменные, потоки, стеки вызовов приложения и другие характеристики поведения во время выполнения приложения.
Остановите приложение, нажав клавиши SHIFT+F5 или кнопку Остановить. Кроме того, можно просто закрыть главное окно приложения (или диалоговое окно командной строки).
Задание простых точек останова
Точки останова — это один из самых простых и важных компонентов надежной отладки. Точка останова указывает, где Visual Studio следует приостановить выполнение кода, чтобы вы могли проверить значения переменных или поведение памяти либо выполнение ветви кода. После установки или удаления точек останова перестраивать проект не нужно.
Установите точку останова, щелкнув дальнее поле строки, в которой требуется приостановить выполнение, или нажмите клавишу F9, чтобы установить точку останова в текущей строке кода. Выполнение кода прерывается (останавливается) перед инструкциями для этой строки кода.
Чаще всего точки останова используются для решения следующих задач.
Чтобы точнее определить источник аварийного завершения или отсутствия отклика программы, расставьте точки останова вокруг и непосредственно в коде вызова метода, который, по вашему мнению, приводит к сбою. При выполнении кода в отладчике удаляйте, а затем снова устанавливайте точки останова ближе друг к другу, пока не найдете строку кода, вызывающую ошибку. Выполнение кода в отладчике описывается в следующем разделе.
При добавлении нового кода установите точку останова в его начале и выполните код, чтобы убедиться в том, что он работает правильно.
При реализации сложного поведения задайте точки останова для алгоритмического кода, чтобы можно было проверить значения переменных и данные при прерывании программы.
При написании кода C или C++ используйте точки останова для остановки кода, чтобы можно было проверить значения адреса (ищите значение NULL) и просмотреть значения счетчиков при отладке ошибок, связанных с памятью.
Дополнительные сведения о точках останова см. в статье Использование точек останова.
Проверка кода во время выполнения
Когда выполнение кода приостанавливается из-за достижения точки останова, строка кода, помеченная желтым цветом (текущий оператор), еще не выполнена. Вы можете выполнить текущий оператор и проверить, как изменились значения. Для выполнения кода в отладчике можно использовать ряд команд пошагового выполнения. Если отмеченный код является вызовом метода, вы можете выполнить шаг с заходом, нажав клавишу F11. Кроме того, можно выполнить шаг с обходом строки кода, нажав клавишу F10. Дополнительные команды и подробные сведения о пошаговом выполнении кода см. в статье Навигация по коду с помощью отладчика.
Код, представленный на предыдущей иллюстрации, может выполняться отладчиком по одному оператору. Для этого можно нажимать клавишу F10 или F11 (так как здесь нет вызова метода, результат выполнения обеих команд будет одинаковым).
Когда отладчик приостанавливает выполнение, можно проверить переменные и стеки вызовов, чтобы разобраться в происходящем. Находятся ли значения в тех диапазонах, которые вы ожидали увидеть? Выполняются ли вызовы в правильном порядке?
Наведите курсор на переменную для просмотра ее текущего значения и ссылок. Если отображается значение, которое вы не ожидали увидеть, возможно, в предыдущем или вызывающем коде имеется ошибка. Более подробные сведения об отладке см. в статье об использовании отладчика.
Кроме того, Visual Studio выводит на экран окно средств диагностики, где можно наблюдать за загрузкой ЦП и использованием памяти приложением в динамике по времени. В дальнейшем в процессе разработки приложения эти средства можно применять для выявления случаев непредвиденно высокой загрузки ЦП или чрезмерного выделения памяти. Это окно можно использовать в сочетании с окном Контрольные значения и точками останова, чтобы определить причину непредвиденно интенсивного использования или неосвобожденных ресурсов. Дополнительные сведения см. в статье Обзор возможностей профилирования.
Запуск модульных тестов
Модульные тесты — это первая линия защиты от ошибок в коде, так как при правильном проведении они позволяют проверять отдельные "модули" кода (как правило, это отдельные функции), которые проще отлаживать, чем всю программу. Visual Studio устанавливает платформу модульного тестирования Майкрософт для управляемого и машинного кода. Платформа модульного тестирования используется для создания модульных тестов, их запуска и передачи результатов таких тестов. Завершив внесение изменений, запустите модульные тесты повторно, чтобы убедиться, что код по-прежнему работает правильно. При использовании выпуска Visual Studio Enterprise можно настроить автоматический запуск тестов после каждой сборки.
Чтобы приступить к работе с модульными тестами, ознакомьтесь со статьей Создание модульных тестов для кода с помощью IntelliTest.
Дополнительные сведения о модульных тестах в Visual Studio, а также о том, как они могут помочь в создании более качественного кода, см. в статье Основные сведения о модульных тестах.
Качество приложения можно улучшить путем регулярного выполнения анализа кода C или C++. Анализ кода помогает найти распространенные проблемы и нарушения хорошей практики программирования. И находит дефекты, которые трудно обнаружить с помощью тестирования. Его предупреждения отличаются от ошибок и предупреждений компилятора: он выполняет поиск конкретных шаблонов кода, которые вызывают проблемы. Это означает, что код является допустимым, но может по-прежнему создавать проблемы для вас или для других пользователей, использующих ваш код.
Настройка наборов правил для проекта
в Обозреватель решенийоткройте контекстное меню для имени проекта и выберите пункт свойства.
При необходимости в списках Конфигурация и платформа выберите конфигурацию сборки и целевую платформу.
для выполнения анализа кода при каждом построении проекта с использованием выбранной конфигурации установите флажок включить Code Analysis при сборке . вы также можете запустить анализ кода вручную, открыв меню анализ , а затем выбрав run Code Analysis onимя_проекта или run Code Analysis on File.
Выберите набор правил , который вы хотите использовать, или создайте Настраиваемый набор правил. если используется LLVM/clang-cl, см. раздел использование Clang-Tidy в Visual Studio для настройки параметров анализа Clang-Tidy.
Стандартные наборы правил C/C++
Visual Studio включает следующие стандартные наборы правил для машинного кода:
Набор правил | Описание |
---|---|
C++ Core Check арифметические правила | Эти правила применяют проверки, связанные с арифметическими операциями, из C++ Core Guidelines. |
Правила C++ Core Check границ | Эти правила применяют профиль границ C++ Core Guidelines. |
Правила класса C++ Core Check | Эти правила применяют проверки, связанные с классами, из C++ Core Guidelines. |
Правила параллелизма C++ Core Check | Эти правила применяют проверки, связанные с параллелизмом, из C++ Core Guidelines. |
Правила констант C++ Core Check | Эти правила применяют к C++ Core Guidelines проверки, связанные с константами. |
Правила объявления C++ Core Check | Эти правила применяют проверки, связанные с объявлениями, из C++ Core Guidelines. |
Правила перечисления C++ Core Check | Эти правила применяют проверки, связанные с перечислением, из C++ Core Guidelines. |
C++ Core Check экспериментальных правил | Эти правила собираются некоторые экспериментальные проверки. В итоге мы планируем, чтобы эти проверки были перемещены на другие наборы правил или полностью удалены. |
C++ Core Check правила функции | Эти правила применяют проверки, связанные с функциями, из C++ Core Guidelines. |
C++ Core Check правила GSL | Эти правила применяют проверки, связанные с библиотекой поддержки руководств, из C++ Core Guidelines. |
Правила времени жизни C++ Core Check | Эти правила применяют профиль времени существования C++ Core Guidelines. |
Правила указателя владельца C++ Core Check | Эти правила применяют проверки управления ресурсами, связанные owner с C++ Core Guidelines. |
Правила необработанных указателей C++ Core Check | Эти правила применяют проверки управления ресурсами, связанные с необработанными указателями, из C++ Core Guidelines. |
Правила C++ Core Check | Эти правила применяют подмножество проверок из C++ Core Guidelines. Используйте этот набор правил, чтобы включить все правила C++ Core Check, за исключением перечисления и экспериментальных наборов правил. |
C++ Core Check правила общих указателей | Эти правила применяют проверки управления ресурсами, связанные с типами с семантикой общего указателя из C++ Core Guidelines. |
Правила STL C++ Core Check | Эти правила применяют проверки, связанные с библиотекой стандартных шаблонов C++ (STL), из C++ Core Guidelines. |
Правила стилей C++ Core Check | Эти правила применяют проверки, связанные с использованием выражений и инструкций, из C++ Core Guidelines. |
Правила типа C++ Core Check | Эти правила применяют профиль типа C++ Core Guidelines. |
Правила для уникальных указателей C++ Core Check | Эти правила применяют проверки управления ресурсами, связанные с типами с семантикой уникальных указателей, из C++ Core Guidelines. |
Правила проверки параллелизма | Эти правила применяют набор проверок шаблона параллелизма Win32 в C++. |
Правила параллелизма | Добавляет правила параллелизма из C++ Core Guidelines правил проверки на параллелизм. |
Минимальные правила Майкрософт для машинного кода | Эти правила касаются наиболее важных проблем в собственном коде, включая потенциальные бреши в системе безопасности и сбои приложений. Мы рекомендуем включить этот набор правил в любой настраиваемый набор правил, создаваемый для собственных проектов. |
Рекомендуемые Майкрософт правила для машинного кода | Эти правила касаются наиболее важных и распространенных проблем в собственном коде. Эти проблемы включают в себя потенциальные бреши в системе безопасности и сбои приложений. Мы рекомендуем включить этот набор правил в любой настраиваемый набор правил, создаваемый для собственных проектов. этот набор правил предназначен для работы с Visual Studio Professional edition и более поздних версий. Он включает все правила в Microsoft Native с минимальными правилами. |
Visual Studio включает следующие стандартные наборы правил для управляемого кода:
Набор правил | Описание |
---|---|
Основные правила корректности Microsoft | Эти правила касаются логических ошибок и распространенных ошибок, возникающих при использовании API-интерфейсов платформы. Включите этот набор правил, чтобы развернуть список предупреждений, о которых сообщили минимальные Рекомендуемые правила. |
Базовые правила разработки Microsoft Basic | Эти правила посвящены применению рекомендаций для упрощения понимания и использования кода. Включите этот набор правил, если проект включает в себя код библиотеки или если вы хотите применить рекомендации по легкому обслуживанию кода. |
Расширенные правила корректности Майкрософт | Эти правила расширяют основные правила корректности, позволяющие максимально увеличить обнаруженную логику и ошибки использования платформы. Особое внимание уделяется конкретным сценариям, например COM-взаимодействию и мобильным приложениям. Рассмотрите возможность включения этого набора правил, если один из этих сценариев применяется к проекту или для поиска дополнительных проблем в проекте. |
Расширенные правила рекомендации по проектированию Майкрософт | Эти правила расширяют базовые правила разработки, позволяющие получить максимальную выгоду от проблем использования и удобства обслуживания. Особое внимание уделяется рекомендациям по именованию. Рассмотрите возможность включения этого набора правил, если проект включает в себя библиотечный код или если вы хотите применять самые высокие стандарты для написания кода, поддерживающего обслуживание. |
Правила глобализации корпорации Майкрософт | Эти правила касаются проблем, которые предотвращают правильное отображение данных в приложении при использовании на разных языках, языковых стандартах и культурах. Включите этот набор правил, если приложение локализовано и (или) глобализовано. |
Минимальное число управляемых корпорацией Майкрософт правил | эти правила касаются наиболее важных проблем в коде, для которых Code Analysis является наиболее точным. эти правила имеют небольшой номер, и они предназначены только для работы в ограниченных Visual Studio выпусках. используйте минимумрекоммендедрулес. ruleset с другими выпусками Visual Studio. |
Рекомендуемые правила, управляемые Майкрософт | Эти правила касаются наиболее важных проблем в коде. Эти проблемы включают в себя потенциальные бреши в системе безопасности, сбои приложений, а другая важная логика и ошибки проектирования. Мы рекомендуем включить этот набор правил в любой настраиваемый набор правил, создаваемый для проектов. |
Минимальные правила Microsoft Mixed (C++/CLR) | Эти правила касаются наиболее важных проблем в проектах C++, поддерживающих среду CLR. Эти проблемы включают в себя потенциальные бреши в системе безопасности, сбои приложений, а другая важная логика и ошибки проектирования. Мы рекомендуем включить этот набор правил в любой настраиваемый набор правил, создаваемый для проектов C++, поддерживающих среду CLR. |
Рекомендуемые правила Microsoft Mixed (C++/CLR) | Эти правила касаются наиболее распространенных и критических проблем в проектах C++, поддерживающих среду CLR. Эти проблемы включают в себя потенциальные бреши в системе безопасности, сбои приложений, а другая важная логика и ошибки проектирования. этот набор правил предназначен для использования в Visual Studio Professional edition и более поздних версиях. |
Правила безопасности Майкрософт | Этот набор правил содержит все правила безопасности Майкрософт. Включите этот набор правил, чтобы максимально увеличить количество потенциальных проблем безопасности, о которых сообщается. |
Чтобы включить каждое правило, выполните следующие действия.
Запуск анализа кода
на странице Code Analysis диалогового окна свойства Project можно настроить выполнение анализа кода каждый раз при сборке проекта. Кроме того, можно запустить анализ кода вручную.
Чтобы запустить анализ кода для решения, выполните следующие действия.
- в меню сборка выберите пункт запустить Code Analysis в решении.
Чтобы запустить анализ кода для проекта, выполните следующие действия.
в Обозреватель решений выберите имя проекта.
в меню сборка выберите команду выполнить Code Analysis дляProject имя.
Выполнение анализа кода для файла:
в Обозреватель решений выберите имя файла.
в меню сборка выберите команду выполнить Code Analysis в файле или нажмите клавиши Ctrl + Shift + Alt + F7.
Будет выполнена компиляция проекта или решения и запуск анализа кода. Результаты отображаются в окне список ошибок.
Анализ и устранение предупреждений функции анализа кода
В окне список ошибок перечислены найденные предупреждения анализа кода. Результаты отображаются в таблице. Если есть дополнительные сведения о конкретном предупреждении, первый столбец содержит элемент управления расширения. Выберите его, чтобы развернуть на экране Дополнительные сведения о данной ошибке. По возможности функция анализа кода выводит на экран номера строк и логику анализа, вызвавшие предупреждение.
Для получения подробных сведений о предупреждении, включая возможные решения проблемы, выберите идентификатор предупреждения в столбце код, чтобы отобразить соответствующую статью справки в Интернете.
дважды щелкните предупреждение, чтобы переместить курсор в строку кода, вызвавшую предупреждение, в редакторе кода Visual Studio. Или нажмите клавишу ВВОД для выбранного предупреждения.
Поняв, в чем заключается проблема, можно разрешить ее в коде. Затем повторно запустите анализ кода, чтобы убедиться, что предупреждение больше не отображается в список ошибок.
Создание рабочих элементов для предупреждений анализа кода
Для регистрации ошибок в журнале из среды Visual Studio можно использовать функцию отслеживания рабочих элементов. чтобы использовать эту функцию, необходимо подключиться к экземпляру Azure DevOps Server (ранее, Team Foundation Server).
Создание рабочего элемента для одного или нескольких предупреждений кода C/C++
В список ошибок разверните и выберите предупреждения.
В контекстном меню предупреждений выберите команду создать рабочий элемент, а затем выберите тип рабочего элемента.
Visual Studio создает один рабочий элемент для выбранных предупреждений и отображает рабочий элемент в окне документа интегрированной среды разработки.
Добавьте дополнительные сведения, а затем выберите сохранить рабочий элемент.
Поиск и фильтрация результатов анализа кода
Можно выполнять поиск в длинных списках предупреждений, а также фильтровать предупреждения в решениях, состоящих из нескольких проектов.
Чтобы отфильтровать предупреждения по названию или идентификатору предупреждения: введите ключевое слово в поле поиска список ошибок.
Некоторые сведения относятся к предварительной версии продукта, в которую до выпуска могут быть внесены существенные изменения. Майкрософт не предоставляет никаких гарантий, явных или подразумеваемых, относительно приведенных здесь сведений.
Представляет ошибки, которые происходят во время выполнения приложения.
Примеры
Комментарии
Этот класс является базовым классом для всех исключений. При возникновении ошибки система или приложение, выполняющееся в данный момент, выдает исключение, содержащее сведения об ошибке. После возникновения исключения он обрабатывается приложением или обработчиком исключений по умолчанию.
Ошибки и исключения
Ошибки во время выполнения могут возникать по различным причинам. Однако не все ошибки должны обрабатываться как исключения в коде. Ниже приведены некоторые категории ошибок, которые могут возникнуть во время выполнения, и соответствующие способы их реагирования.
Ошибки использования. Ошибка использования представляет собой ошибку в логике программы, которая может привести к исключению. Однако ошибка должна быть устранена не с помощью обработки исключений, а путем изменения кода сбоя. Например, переопределение Object.Equals(Object) метода в следующем примере предполагает, что obj аргумент всегда должен быть ненулевым.
Исключение NullReferenceException , которое obj может быть устранено null , изменив исходный код, чтобы явным образом протестировать значение NULL перед вызовом Object.Equals переопределения, а затем повторной компиляции. В следующем примере содержится исправленный исходный код, обрабатывающий null аргумент.
Вместо обработки исключений для ошибок использования можно использовать Debug.Assert метод для выявления ошибок использования в отладочных сборках, а Trace.Assert также метода для выявления ошибок использования как в отладочных, так и в сборках выпуска. Дополнительные сведения см. в разделе Утверждения в управляемом коде.
Ошибки программы. Ошибка программы — это ошибка во время выполнения, которую не обязательно можно избежать путем написания кода без ошибок.
В некоторых случаях ошибка программы может отражать ожидаемое или обычное состояние ошибки. В этом случае может потребоваться избежать использования обработки исключений для устранения ошибки программы и вместо этого повторить операцию. Например, если пользователь должен ввести дату в определенном формате, можно проанализировать строку даты, вызвав DateTime.TryParseExact метод, который возвращает Boolean значение, указывающее, успешно ли выполнена операция синтаксического анализа, а не с помощью DateTime.ParseExact метода, что вызывает FormatException исключение, если строка даты не может быть преобразована в DateTime значение. Аналогичным образом, если пользователь пытается открыть файл, который не существует, можно сначала вызвать File.Exists метод, чтобы проверить, существует ли файл, и, если он этого не делает, предложите пользователю создать его.
В других случаях ошибка программы отражает непредвиденное условие ошибки, которое может быть обработано в коде. Например, даже если вы проверили, что файл существует, он может быть удален до его открытия или может быть поврежден. В этом случае попытка открыть файл путем создания экземпляра StreamReader объекта или вызова Open метода может вызвать FileNotFoundException исключение. В таких случаях следует использовать обработку исключений для восстановления после ошибки.
Сбои системы. Сбой системы — это ошибка во время выполнения, которая не может обрабатываться программным способом. Например, любой OutOfMemoryException метод может вызвать исключение, если среде CLR не удается выделить дополнительную память. Обычно системные сбои не обрабатываются с помощью обработки исключений. Вместо этого вы можете использовать такое событие, как AppDomain.UnhandledException и вызвать Environment.FailFast метод для регистрации сведений об исключении и уведомить пользователя о сбое до завершения работы приложения.
Блоки try/catch
Среда CLR предоставляет модель обработки исключений, основанную на представлении исключений в виде объектов, а также разделение кода программы и кода обработки исключений на try блоки и catch блоки. Может быть один или несколько catch блоков, каждый из которых предназначен для обработки определенного типа исключения, или один блок, предназначенный для перехвата более конкретного исключения, чем другой блок.
Если приложение обрабатывает исключения, возникающие во время выполнения блока кода приложения, код должен быть помещен в try инструкцию и называется блоком try . Код приложения, обрабатывающий исключения, создаваемые блоком try , помещается в catch оператор и называется блоком catch . С блоком try связаны ноль или более catch блоков, каждый из которых catch включает фильтр типов, определяющий типы исключений, которые он обрабатывает.
При возникновении исключения в try блоке система выполняет поиск связанных catch блоков в том порядке, в который они отображаются в коде приложения, пока не будет обнаружен catch блок, обрабатывающий исключение. Блок catch обрабатывает исключение типа T , если фильтр типов блока catch указывает T или какой-либо тип, T производный от. Система перестает выполнять поиск после обнаружения первого catch блока, обрабатывающего исключение. По этой причине в коде приложения необходимо указать блок, обрабатывающий тип, catch перед блоком catch , обрабатывающим его базовые типы, как показано в примере ниже. Блок catch, обрабатывающий дескриптор System.Exception , задается последним.
Если ни один из catch блоков, связанных с текущим try блоком, не обрабатывает исключение, а текущий блок вложен в другие try блоки в текущем try вызове, выполняется поиск блоков, catch связанных со следующим вложенным try блоком. Если блок для исключения не catch найден, система выполняет поиск предыдущих уровней вложения в текущем вызове. Если в текущем вызове не catch найден блок исключения, исключение передается в стек вызовов, а предыдущий кадр стека выполняет поиск catch блока, обрабатывающего исключение. Поиск стека вызовов продолжается до тех пор, пока исключение не будет обработано или пока в стеке вызовов не будет больше кадров. Если верхняя часть стека вызовов достигается без поиска catch блока, обрабатывающего исключение, обработчик исключений по умолчанию обрабатывает его и приложение завершает работу.
Функции типа исключений
Типы исключений поддерживают следующие функции:
Состояние стека вызовов при возникновении исключения. Свойство StackTrace содержит трассировку стека, которую можно использовать для определения места возникновения ошибки в коде. Трассировка стека перечисляет все вызываемые методы и номера строк в исходном файле, где выполняются вызовы.
Свойства класса exception
Класс Exception содержит ряд свойств, которые помогают определить расположение кода, тип, файл справки и причину исключения: StackTrace, InnerExceptionMessage, HelpLinkSourceHResult, и . TargetSiteData
Если между двумя или более исключениями существует причинная связь, InnerException свойство сохраняет эти сведения. Внешнее исключение создается в ответ на это внутреннее исключение. Код, обрабатывающий внешнее исключение, может использовать сведения из предыдущего внутреннего исключения для более правильной обработки ошибки. Дополнительные сведения об исключении могут храниться в виде коллекции пар "ключ-значение" в свойстве Data .
Чтобы предоставить пользователю подробные сведения о причинах возникновения исключения, HelpLink свойство может содержать URL-адрес (или URN) в файле справки.
Класс Exception использует COR_E_EXCEPTION HRESULT, имеющий значение 0x80131500.
Список начальных значений свойств для экземпляра Exception класса см. в Exception конструкторах.
Вопросы производительности
Создание или обработка исключения потребляет значительное количество системных ресурсов и времени выполнения. Создает исключения только для обработки действительно чрезвычайных условий, а не для обработки прогнозируемых событий или управления потоком. Например, в некоторых случаях, например при разработке библиотеки классов, можно создать исключение, если аргумент метода недопустим, так как предполагается, что метод будет вызван с допустимыми параметрами. Недопустимый аргумент метода, если он не является результатом ошибки использования, означает, что произошло что-то необычное. И наоборот, не вызывайте исключение, если введенные пользователем данные недопустимы, так как пользователи могут иногда вводить недопустимые данные. Вместо этого предоставьте механизм повтора, чтобы пользователи могли вводить допустимые входные данные. Не следует использовать исключения для обработки ошибок использования. Вместо этого используйте утверждения для выявления и исправления ошибок использования.
Кроме того, не создавайте исключение при достаточном коде возврата; не преобразуйте код возврата в исключение; и не перехватывать исключение, игнорировать его, а затем продолжать обработку.
Повторный вызов исключения
Во многих случаях обработчик исключений просто хочет передать исключение вызывающему объекту. Чаще всего это происходит в следующих случаях:
Приложение или библиотека, столкнувшиеся с неустранимым исключением. Обработчик исключений может регистрировать исключение, а затем повторно создавать исключение.
Затем вызывающий объект вызывается FindOccurrences дважды. Во втором вызове FindOccurrences вызывающий объект передает строку null поиска, которая вызывает String.IndexOf(String, Int32) исключение ArgumentNullException . Это исключение обрабатывается методом FindOccurrences и передается обратно вызывающей стороне. Так как оператор throw используется без выражения, выходные данные из примера показывают, что стек вызовов сохраняется.
В отличие от этого, если исключение создается повторно с помощью
оператор , полный стек вызовов не сохраняется, и пример создаст следующие выходные данные:
Немного более громоздкой альтернативой является создание нового исключения и сохранение сведений о стеке вызовов исходного исключения во внутреннем исключении. Затем вызывающий объект может использовать свойство нового исключения для получения кадра InnerException стека и других сведений об исходном исключении. В этом случае оператор throw имеет следующий тип:
Пользовательский код, обрабатывающий исключение, должен знать, что InnerException свойство содержит сведения об исходном исключении, как показано в следующем обработчике исключений.
Выбор стандартных исключений
В следующей таблице перечислены распространенные типы исключений и условия их создания.
Исключение | Условие |
---|---|
ArgumentException | Недопустимый аргумент, который передается в метод. |
ArgumentNullException | Аргумент, передаваемый методу null . |
ArgumentOutOfRangeException | Аргумент находится за пределами диапазона допустимых значений. |
DirectoryNotFoundException | Недопустимая часть пути к каталогу. |
DivideByZeroException | Знаменатель в целочисленной или Decimal делении операции равен нулю. |
DriveNotFoundException | Диск недоступен или не существует. |
FileNotFoundException | Файл не существует. |
FormatException | Значение не имеет соответствующего формата для преобразования из строки с помощью такого метода Parse преобразования. |
IndexOutOfRangeException | Индекс находится за пределами массива или коллекции. |
InvalidOperationException | Вызов метода недопустим в текущем состоянии объекта. |
KeyNotFoundException | Не удается найти указанный ключ для доступа к элементу в коллекции. |
NotImplementedException | Метод или операция не реализованы. |
NotSupportedException | Метод или операция не поддерживаются. |
ObjectDisposedException | Операция выполняется для объекта, который был удален. |
OverflowException | Операция арифметического приведения, приведения или преобразования приводит к переполнению. |
PathTooLongException | Путь или имя файла превышает максимальную системную длину. |
PlatformNotSupportedException | Операция не поддерживается на текущей платформе. |
RankException | Массив с неправильным числом измерений передается в метод. |
TimeoutException | Истек интервал времени, выделенный для операции. |
UriFormatException | Используется недопустимый универсальный код ресурса (URI). |
Реализация пользовательских исключений
Чтобы определить собственный класс исключений, выполните следующие действия.
Определение класса, наследуемого от Exception. При необходимости определите все уникальные члены, необходимые классу для предоставления дополнительных сведений об исключении. Например, ArgumentException класс содержит ParamName свойство, указывающее имя параметра, аргумент которого вызвал исключение, а RegexMatchTimeoutException свойство содержит MatchTimeout свойство, указывающее интервал времени ожидания.
При необходимости переопределите все унаследованные члены, функциональные возможности которых необходимо изменить или изменить. Обратите внимание, что большинство существующих производных Exception классов не переопределяют поведение унаследованных элементов.
Определите, является ли настраиваемый объект исключения сериализуемым. Сериализация позволяет сохранять сведения об исключении и разрешать доступ к сведениям об исключениях сервером и прокси-сервером клиента в контексте удаленного взаимодействия. Чтобы сделать объект исключения сериализуемым, пометьте его атрибутом SerializableAttribute .
Определите конструкторы класса исключений. Как правило, классы исключений имеют один или несколько из следующих конструкторов:
Exception(), который использует значения по умолчанию для инициализации свойств нового объекта исключения.
Exception(SerializationInfo, StreamingContext)— конструктор protected , который инициализирует новый объект исключения из сериализованных данных. Этот конструктор следует реализовать, если вы решили сделать объект исключения сериализуемым.
В следующем примере показано использование пользовательского класса исключений. Он определяет исключение, которое возникает NotPrimeException при попытке клиента получить последовательность простых чисел, указав начальное число, которое не является простым. Исключение определяет новое свойство, NonPrime которое возвращает неисчислимое число, вызвавшее исключение. Помимо реализации защищенного конструктора без параметров и конструктора с SerializationInfo параметрами StreamingContext для сериализации NotPrimeException класс определяет три дополнительных конструктора для поддержки NonPrime свойства. Каждый конструктор вызывает конструктор базового класса в дополнение к сохранению значения незначимого числа. Класс NotPrimeException также помечается атрибутом SerializableAttribute .
Класс, PrimeNumberGenerator показанный в следующем примере, использует Sieve of Eratosthenes для вычисления последовательности простых чисел от 2 до предела, указанного клиентом в вызове конструктора класса. Метод GetPrimesFrom возвращает все простые числа, которые больше или равны заданному нижнему пределу, но вызывает NotPrimeException исключение, если это нижнее ограничение не является простым числом.
В следующем примере выполняется два вызова GetPrimesFrom метода с неисчислимыми числами, одна из которых пересекает границы домена приложения. В обоих случаях исключение создается и успешно обрабатывается в клиентском коде.
Конструкторы
Инициализирует новый экземпляр класса Exception.
Инициализирует новый экземпляр класса Exception с сериализованными данными.
Свойства
Возвращает коллекцию пар «ключ-значение», предоставляющую дополнительные сведения об исключении.
Получает или задает ссылку на файл справки, связанный с этим исключением.
Возвращает или задает HRESULT — кодированное числовое значение, присвоенное определенному исключению.
Возвращает экземпляр класса Exception, который вызвал текущее исключение.
Возвращает или задает имя приложения или объекта, вызывавшего ошибку.
Получает строковое представление непосредственных кадров в стеке вызова.
Возвращает метод, создавший текущее исключение.
Методы
Определяет, равен ли указанный объект текущему объекту.
При переопределении в производном классе возвращает исключение Exception, которое является первопричиной одного или нескольких последующих исключений.
Служит хэш-функцией по умолчанию.
При переопределении в производном классе задает объект SerializationInfo со сведениями об исключении.
Возвращает тип среды выполнения текущего экземпляра.
Возвращает объект Type для текущего экземпляра.
Создает неполную копию текущего объекта Object.
Создает и возвращает строковое представление текущего исключения.
События
Возникает, когда исключение сериализовано для создания объекта состояния исключения, содержащего сериализованные данные об исключении.
Читайте также: