Leif Gram: Mr. Fix

Как сделать код поддерживаемым

Как добиться того, чтобы ваш код был понятен коллегам, которым придется с ним работать? Обычно рекомендуют какое-то наивное шаманство: давайте переменным и функциям говорящие имена. Делайте функции не слишком длинными, не слишком короткими. Пишите комментарии, да не в стиле i=0 /*обнулим значение i*/, а объясняющие происходящее в глобальном контексте. Как будто содержание комментариев, имена переменных или длина функций имеют значение.
Нет, единственный способ - это писать нужный код. Вот тогда разберутся и будут хорошо его понимать.
расскажите это пишущим код на Perl, вместе с ними и посмеетесь.
и как оно, читать чужой код на перле, если он без комментариев ?
хорошо, спрошу иначе. Не получилось бы быстрее разбираться, если код был бы снабжен комментариями?
Это многое объясняет. На перле, конечно, от комментариев, имен функций или их длины разницы никакой.

(Я просто зашел покормить троллей. Но ты первый начал.)
Есть такие фокусы, когда один и тот же исходник является валидным для нескольких компиляторов на различные непохожие друг на друга языки программирования. За счет того, что они видят разные его части как код и как комментарии. Вот тогда комментарии важны.
лучше всего не писать ненужного кода. Типа фабрик декораторов фасадов.
И выкинуть языки которые это требуют.
Как человек постоянно разбирающий чужой код:
Писать комментарии надо не что там происходит (это итак нормальный потомок разберётся)
надо писать зачем оно изначально вообще писалось. Вот это как правило та ещё загадка, отсутствие ответа на которую серьёзно мешает.
А вот такие комментарии практически никто не пишет, пишут бессмысленное "вот тут мы берём значение X и передаём в ф-ию Y" - а я что, без комментария не вижу чтоли?!

Edited at 2017-10-18 11:50 am (UTC)
Натурально. В частности, крайне полезны комментарии вида "без этого уже пробовали, не работает при таком-то стечении обстоятельств".