Почему комментарии к коду являются запахом кода: Аргументы в пользу самодокументируемого кода

Почему комментарии к коду являются запахом кода: Аргументы в пользу самодокументируемого кода

Загадка Комментариев: Почему Меньше Часто Больше В мире разработки программного обеспечения, дебаты о комментариях к коду продолжаются уже давно. Хотя некоторые утверждают, что комментарии необходимы для ясности и поддерживаемости, другие видят в них необходимое зло или даже “запах кода.” В этой статье мы рассмотрим аргумент о том, что комментарии к коду, особенно те, которые объясняют, что делает код, действительно являются “запахом кода” и почему самодокументирующий код является правильным подходом. Диллемма “Что” и “Почему” Комментарии, которые объясняют, что делает код, часто называются “что”-комментариями. Эти комментарии излишни и могут быстро устареть, что приводит к путанице и недоразумениям. Например, рассмотрим следующий пример: ...

19 сентября 2024 06:00 · 4 минуты · 658 слов · Maxim Zhirnov