Напишите для обзора
Лучшая практика 4 - Код должен быть написан для проверки
При написании программного кода имейте в виду, что кто-то будет проверять ваш код, и вам придется столкнуться с критикой по одному или нескольким из следующих пунктов, но не ограничиваясь ими:
- Плохое кодирование
- Не соответствует стандарту
- Не имея в виду производительность
- История, отступы, комментарии не подходят.
- Читаемость плохая
- Открытые файлы не закрываются
- Выделенная память не освобождена
- Слишком много глобальных переменных.
- Слишком много жесткого кодирования.
- Плохая обработка ошибок.
- Без модульности.
- Повторный код.
При кодировании помните обо всех вышеупомянутых моментах и остановите их, прежде чем они перейдут в исходный код. Как только вы закончите кодирование, сделайте самопроверку хотя бы один раз. Я уверен, что самопроверка поможет вам самостоятельно устранить 90% проблем.
Когда вы полностью закончите кодирование и самостоятельную проверку, запросите у коллеги проверку кода. Я настоятельно рекомендую с радостью принимать комментарии к обзору и должен быть благодарен вашим рецензентам кода за комментарии. В то же время никогда не стоит критиковать исходный код, написанный кем-то другим. Если вы никогда этого не делали, попробуйте один раз и проверьте выражение кодера.
Принимайте критику, но не критикуйте
Плохо написанный исходный код учит писать хороший исходный код, если вы относитесь к нему положительно и извлекаете из него урок.
Ваша цель должна заключаться в том, чтобы в первую очередь остановить ошибки и создать БЕЗОШИБОЧНЫЙ код. Думайте, как тестировщик, так что у вас должна быть проблема для тестировщиков.