смотрю на свой код трех-четырех годичной давности возникает то самое чувство: «Что за древнее писание?»
Я придерживаюсь мнения, что писать код надо так, чтобы комментариев было как можно меньше Не считая документацию
Иногда может быть так: ты думаешь, что это очевидно, но для другого человека данное поведение является отнюдь неочевидным
По идее такое должно на кодревью выявляться
А потом смена команды))) и новая команда без контекста не понимает)))
И документация - простое описание вида: кто и когда это сделал, что оно делает, что на входе, что на выходе хорошо помогает, думаю даже при смене команды.
doxygen вам в помощь :)
> кто и когда это сделал git blame в помощь
Ну, да и это тоже :)
Против документации ничего не имею против Я против только избыточных комментариев
Так да, о том и речь, что лучше оставить комментарий, чтоб не возникало потом лишних вопросов
Согласен - комментарии в каждой второй строке - зло.
Была запланирована ещё и вторая часть статьи, где про "не бесполезную документацию"
Обсуждают сегодня