Информация об изменениях

Сообщение Re: Нужно ли комментировать код? от 20.01.2022 21:23

Изменено 20.01.2022 21:28 bnk

Re: Нужно ли комментировать код?
Здравствуйте, gress, Вы писали:

G>Столкнулась с новым веянием, согласно которому считается, что код комментирует себя сам. И комментарии не только не нужны, а вообще вредны.

G>Так как я боец старой формации, для меня это дикость. Но тут так получилось, что я сейчас тим лид, а мнения в команде разделились.
G>Поэтому интересно, я действительно динозавр и код теперь никто не комментирует?

Ну как, во всем нужен баланс
Не нужно комментировать вещи, которые и так очевидны если посмотреть на код.
Вещи, которые не очевидны, комментировать все еще нужно.

То есть, хорошие комментарии должны скорее отвечать не на вопрос "как" (это должно быть понятно из кода) или "что это" (должно быть понятно из названия), а на вопрос "зачем это", или "почему именно так, а не иначе".
Еще вариант, когда комментарии нужны, это когда они например используются для автоматической генерации документации для пользователя.
Re: Нужно ли комментировать код?
Здравствуйте, gress, Вы писали:

G>Столкнулась с новым веянием, согласно которому считается, что код комментирует себя сам. И комментарии не только не нужны, а вообще вредны.

G>Так как я боец старой формации, для меня это дикость. Но тут так получилось, что я сейчас тим лид, а мнения в команде разделились.
G>Поэтому интересно, я действительно динозавр и код теперь никто не комментирует?

Ну как, во всем нужен баланс
Не нужно комментировать вещи, которые и так очевидны если посмотреть на код.
Вещи, которые не очевидны, комментировать все еще нужно.

То есть, хорошие комментарии должны скорее отвечать не на вопрос "как" (это должно быть понятно из кода) или "что это" (должно быть понятно из названия), а на вопрос "зачем это", или "почему именно так, а не иначе".
Еще вариант, когда (даже тупые) комментарии нужны, это когда они например используются для автоматической генерации документации для пользователя.