День 1420. #Debugging Я Исправил Ошибку. Что Дальше? Чем больше кода вы пишете, тем больше ошибок создаёте. Т.е. как разработчик ПО вы должны тратить часть своего времени на отладку. Есть несколько общих шагов при отладке приложения: 1. Получение всей необходимой информации для понимания проблемы (этапы воспроизведения, стек вызовов, журналы и т. д.) 2. Воспроизведение проблемы и отладка кода 3. Исправление кода Однако мы можем сделать больше, чем просто решить конкретную проблему. Вот несколько вопросов, которые вы должны задать себе при исправлении ошибки. 1. Легко ли было получить информацию, необходимую для воспроизведения ошибки? - Какую версию приложения запускает пользователь? - Какова конфигурация среды? (ОС, версия .NET, текущая культура, разрешение экрана, ОЗУ, загрузка ЦП и т. д.) - Какая конфигурация приложения? (Пользовательские настройки) - В случае сбоя доступен ли стек вызовов и понятно ли сообщение об ошибке? - Есть ли доступ к логам? Легко ли их получить и прочитать? Предоставляют ли они достаточно информации и контекста? - Есть ли доступ к данным телеметрии? На этом этапе у вас должно быть хорошее представление о проблеме, не глядя на код. 2. Легко ли воспроизвести проблему в среде разработки? - Легко ли начать работу над проектом? (Получить код/Открыть проект в IDE/Начать отладку) - Правильно ли задокументирован процесс? - Нужно ли вручную настраивать секреты для подключения к внешним службам? - Требуется ли дополнительное ПО на машине и как его получить? - Легко ли настроить ту же среду, что и в рабочей среде (Azure Web App, Docker, Kubernetes)? Легко ли отлаживать эту среду? - Можно ли получить анонимизированные живые данные, когда это необходимо? - Если нельзя воспроизвести проблему в своей среде, можно ли вы отладить промежуточную/производственную версию или получить дамп? Будьте очень осторожны, когда делаете это, чтобы не заблокировать работающий сервис из-за достижения точки останова и не раскрыть важные данные. 3. Легко ли работать над кодовой базой? - Хорошо ли организован код? Находите ли вы то, что ищете? - Код легко читается? Соблюдается ли соглашение об именовании и стиль написания кода? - Есть ли в коде неявные зависимости? - Насколько быстро вы можете вносить изменения и наблюдать за их результатами в приложении? - Можете ли вы воспользоваться своей IDE для отладки? - Можете ли использовать точки останова и просматривать локальные значения или вычислять выражения? - Ваши типы переопределяют ToString или отмечены атрибутом [DebuggerDisplay], чтобы вы могли быстро увидеть значения во время отладки? 4. Почему разработчик внёс эту ошибку в код? На этом этапе вы должны найти причины, по которым разработчик допустил ошибку. Сделайте шаг назад и проанализируйте проблему. - Код слишком сложный? - Методы слишком длинные и слишком сложные? - Используете ли вы правильный инструмент для выполнения работы? - Возможна ли путаница? Например, два типа с одинаковым именем в разных пространствах имен. - Ясно ли объясняются пред- и пост-условия метода (возможно ли передать/вернуть null, дату локальную/UTC, относительный/абсолютный путь? - Отсутствует или неясна документация/комментарии? - Влияет ли изменение части приложения на другую часть? - Надёжны ли тесты? - Есть ли хотя бы один сквозной тест для основного сценария приложения? Источник: https://www.meziantou.net/how-to-correctly-fix-a-bug.htm