Бесполезные комментарии
Анти-паттерн
Лишние комментарии загромождают код и усложняют его поддержку: при внесении изменений придётся править сразу в нескольких местах - менять код и переписывать комментарии.
Пример¶
Что происходит в коде, должно быть понятно без дополнительных комментариев, а вот зачем - для этого уже могут понадобиться пояснения.
Плохо:
def show_active_passcards(request):
active_passcards = Passcard.objects.filter(is_active=True) # запрос для получения активных пропусков
context = {
'active_passcards': active_passcards, # активные пропуска
}
return render(request, 'active_passcards.html', context)
Хорошо:
def show_active_passcards(request):
active_passcards = Passcard.objects.filter(is_active=True)
context = {
'active_passcards': active_passcards,
}
return render(request, 'active_passcards.html', context)