Ревью кода
07.12.2022
Ревью кода – проверка исходного кода программы с целью обнаружения и исправления ошибок и неточностей, которые остались незамеченными при начальной разработке.
В процессе проверки исходного кода программы могут быть выявлены и исправлены фактические ошибка, увеличена производительность кода программы и ошибки форматирования кода, читабельность кода.
Качество программного кода
Посредством ревью кода улучшается качество программного кода, соответственно, улучшаются навыки программиста.
Как правило, ревью кода не выполняют новички. Эту работу выполняют опытные программисты.
Автор кода отправляет его на ревью, а рецензент анализирует код и принимает решение одобавления представленного кода в общий проект.
Ревью кода довольно сложный процесс и проводится в несколько раундов или этапов. каждый этап начинается с того, что автор присылает ряд изменений рецензенту, которые он считает потрясающими, требующими внимания. Рецензент же рассматривает изменения и если считает, что такие изменения не нужны, то должен обосновать свое решение для автора.
Ревью кода — это своеобразный обмен знаниями и навыками между программистами.
Ошибки из-за которых код работает неверно являются фактическими. Фактические ошибки относятся к самому алгоритму, который используется для решения поставленной задачи.
Производительность программного кода
Когда речь идет о производительности программного кода, то подразумевается насколько быстро выполняется программный код.
Рассмотрим обще доступный пример компьютерного кода проверки числа на простоту.
Первая версия программного кода
Поставлена задача: Перебираем все числа от 2 до num -1 и делаем проверку делимости числа num на i
Программа будет выглядеть следующим образом:
num = int(input())
flag = True
for i in range(2, num):
if num % i == 0:
flag = False
if num > 1 and flag == True:
print('Число простое')
else:
print('Число составное')Причем, если на вход программе подается простое число num = 1934234249 , то она будет работать примерно 270 секунд = 4.5 минуты.
Вторая версия программного кода
Несложно понять, что перебирать все числа от 2 до num -1 не имеет смысла. Достаточно проверить числа от 2 до num//2+1:
num = int(input())
flag = True
for i in range(2, num // 2 + 1):
if num % i == 0:
flag = False
if num > 1 and flag == True:
print('Число простое')
else:
print('Число составное')Если программе на вход подается простое число num = 1934234249, то она будет работать примерно 130 секунд = 2.2 минуты. Фактически, немного изменив код программы, автор программы улучшает время работы программы в два раза.
Читабельность программного кода
Код, написанный одним программистом, должен достаточно легко читаться другим программистом.
Для того, чтобы это условие было осуществимо, следует автору кода придерживаться стандарта PEP8.
Обращаем внимание, что следует обращать внимание на отдельные моменты при написании программного кода:
- Отступы и пробелы: используйте 4 пробела на один уровень отступа и никогда не смешивайте символы табуляции и пробелы;
- Названия переменных: используйте говорящие названия для переменных (total, counter, produkt и следуйте стилю lower_case_with_underscores (слова из маленьких букв с подчеркиваниями);
- Пустые строки: дополнительные отступы пустыми строками могут быть изредка полезны для выделения группы логически связанных частей программы: инициализация переменных, основной алгоритм, завершающая проверка и т.д.;
- Комментарии: комментарии должны являться законченными предложениями. И помните, комментарии, которые противоречат коду, хуже, чем отсутствие комментариев. Всегда исправляйте комментарии, если меняете код в процессе работы.
Экономист по первому образованию и учитель информатики по второму. Преподаю в школе информатику, программирование, сайтостроение, экономику.