Сообщение Re: Привычка ставить стандартные комментарии от 15.12.2021 11:46
Изменено 15.12.2021 11:47 fk0
Re: Привычка ставить стандартные комментарии
Здравствуйте, Khimik, Вы писали:
K>Я никогда не работал на работодателя, и у меня сформировался свой стиль писания кода. В частности, сложилась привычка писать стандартные комментарии. Не знаю как в других языках, а Delphi часто по коду без комментариев непонятно, что означает тот или другой end; (конец программной скобки).
Такой комментарий имеет смысл, если блок кода не влезает на экран. А если такой код написан,
то пора задуматься, что это порядочный говнокод и требует рефакторинга. Реально большие блоки
кода и такие комментарии нужны очень редко и обычно скорей встречаются в парах #ifdef/#endif
у C-макропроцессора, где иначе чёрт ногу сломит.
K>Есть много других аналогичных примеров: для case, для for и для произвольных программных скобок
Заставь дурака богу молиться -- лоб расшибёт.
K>Насколько всё это актуально в других языках?
Везде малоактуально.
K> И имеет ли смысл выработать привычку вообще во всех таких случаях писать стандартный комментарий,
Комментарии вида var x = y; (* x = y *) только вызывает желание долго пинать автора ногами.
Комментарий либо должен быть информативный, либо его не должно быть.
K>Я никогда не работал на работодателя, и у меня сформировался свой стиль писания кода. В частности, сложилась привычка писать стандартные комментарии. Не знаю как в других языках, а Delphi часто по коду без комментариев непонятно, что означает тот или другой end; (конец программной скобки).
Такой комментарий имеет смысл, если блок кода не влезает на экран. А если такой код написан,
то пора задуматься, что это порядочный говнокод и требует рефакторинга. Реально большие блоки
кода и такие комментарии нужны очень редко и обычно скорей встречаются в парах #ifdef/#endif
у C-макропроцессора, где иначе чёрт ногу сломит.
K>Есть много других аналогичных примеров: для case, для for и для произвольных программных скобок
Заставь дурака богу молиться -- лоб расшибёт.
K>Насколько всё это актуально в других языках?
Везде малоактуально.
K> И имеет ли смысл выработать привычку вообще во всех таких случаях писать стандартный комментарий,
Комментарии вида var x = y; (* x = y *) только вызывает желание долго пинать автора ногами.
Комментарий либо должен быть информативный, либо его не должно быть.
Re: Привычка ставить стандартные комментарии
Здравствуйте, Khimik, Вы писали:
K>Я никогда не работал на работодателя, и у меня сформировался свой стиль писания кода. В частности, сложилась привычка писать стандартные комментарии. Не знаю как в других языках, а Delphi часто по коду без комментариев непонятно, что означает тот или другой end; (конец программной скобки).
Такой комментарий имеет смысл, если блок кода не влезает на экран. А если такой код написан,
то пора задуматься, что это порядочный говнокод и требует рефакторинга. Реально большие блоки
кода и такие комментарии нужны очень редко и обычно скорей встречаются в парах #ifdef/#endif
у C-макропроцессора, где иначе чёрт ногу сломит. Ещё namespaces в C++ бывают большие.
K>Есть много других аналогичных примеров: для case, для for и для произвольных программных скобок
Заставь дурака богу молиться -- лоб расшибёт.
K>Насколько всё это актуально в других языках?
Везде малоактуально.
K> И имеет ли смысл выработать привычку вообще во всех таких случаях писать стандартный комментарий,
Комментарии вида var x = y; (* x = y *) только вызывает желание долго пинать автора ногами.
Комментарий либо должен быть информативный, либо его не должно быть.
K>Я никогда не работал на работодателя, и у меня сформировался свой стиль писания кода. В частности, сложилась привычка писать стандартные комментарии. Не знаю как в других языках, а Delphi часто по коду без комментариев непонятно, что означает тот или другой end; (конец программной скобки).
Такой комментарий имеет смысл, если блок кода не влезает на экран. А если такой код написан,
то пора задуматься, что это порядочный говнокод и требует рефакторинга. Реально большие блоки
кода и такие комментарии нужны очень редко и обычно скорей встречаются в парах #ifdef/#endif
у C-макропроцессора, где иначе чёрт ногу сломит. Ещё namespaces в C++ бывают большие.
K>Есть много других аналогичных примеров: для case, для for и для произвольных программных скобок
Заставь дурака богу молиться -- лоб расшибёт.
K>Насколько всё это актуально в других языках?
Везде малоактуально.
K> И имеет ли смысл выработать привычку вообще во всех таких случаях писать стандартный комментарий,
Комментарии вида var x = y; (* x = y *) только вызывает желание долго пинать автора ногами.
Комментарий либо должен быть информативный, либо его не должно быть.