Закомментированный код
Анти-паттерн
Закомментированный код приносит больше вреда, чем пользы. Он может быть полезен в процессе отладки для быстрой смены логики, но в рабочей версии кода ему не место.
Пример 1¶
Не только Отладочный print, но и его закомментированный вариант является мусором.
Плохо:
def do_something(value):
# print(value)
...
Хорошо:
def do_something(value):
...
Пример 2¶
Если что-то можно закомментировать по той причине, что оно не используется, значит этому в принципе не место в рабочей версии кода.
Плохо:
from math import pi
def calculate_circle_area(radius):
circle_area = pi * radius ** 2
return circle_area
# def calculate_square_area(side):
# return side * side
def main():
radius = ...
circle_area = calculate_circle_area(radius)
Хорошо:
from math import pi
def calculate_circle_area(radius):
circle_area = pi * radius ** 2
return circle_area
def main():
radius = ...
circle_area = calculate_circle_area(radius)