Вопрос комментировать или не комментировать код для меня вполне понятен, стараюсь придерживаться правил:
— код сам себя должен себя документировать.
— комментарии ради комментариев не нужны и вредны.
— комментировать надо то, что может вызвать вопросы:
чтобы выявить такие места надо постараться взглянуть на кусок кода чужими глазами.
— в то же время если проект требует по каким-то причинам жесткого документирования,
то надо придерживаться стандартов данного проекта, а не каких-то общих советов.
А вот вопрос на каком языке комментировать мне не совсем ясен.
Я никогда не комментировал код на русском языке.
Когда над проектом работают или возможно будут работать не только русско-говорящие разработчики, то вопрос отпадает сам собой.
Но если знаешь, что проект будет разрабатываться и поддерживаться только русскими программистами…
Почему-то у меня и у многих коллег с кем работал есть стойкий негатив к русским комментариям в коде, но нормальных аргументов против почти нет.
И это при том, что у самого английский далеко не безупречный.
аргументы какие-то такие:
— с русскими символами может быть проблема с кодировкой,
— вдруг в будущем для работы над проектом будут привлечены аутсорс-команды,
— как бы принято писать на английском уж и код и комментарии,
— как бы криво криво писать не на английском
т.е аргументов против нормальных я не знаю, аргумент за у меня такой:
— не все хорошо знают английский и могут быстро и правильно писать на нем, а кривые комментарии на английском большее зло чем все остальное
Вопрос касается также и, например, упомянутых здесь логов комита
Будет интересно услышать любые мнения по этому поводу.
— код сам себя должен себя документировать.
— комментарии ради комментариев не нужны и вредны.
— комментировать надо то, что может вызвать вопросы:
чтобы выявить такие места надо постараться взглянуть на кусок кода чужими глазами.
— в то же время если проект требует по каким-то причинам жесткого документирования,
то надо придерживаться стандартов данного проекта, а не каких-то общих советов.
А вот вопрос на каком языке комментировать мне не совсем ясен.
Я никогда не комментировал код на русском языке.
Когда над проектом работают или возможно будут работать не только русско-говорящие разработчики, то вопрос отпадает сам собой.
Но если знаешь, что проект будет разрабатываться и поддерживаться только русскими программистами…
Почему-то у меня и у многих коллег с кем работал есть стойкий негатив к русским комментариям в коде, но нормальных аргументов против почти нет.
И это при том, что у самого английский далеко не безупречный.
аргументы какие-то такие:
— с русскими символами может быть проблема с кодировкой,
— вдруг в будущем для работы над проектом будут привлечены аутсорс-команды,
— как бы принято писать на английском уж и код и комментарии,
— как бы криво криво писать не на английском
т.е аргументов против нормальных я не знаю, аргумент за у меня такой:
— не все хорошо знают английский и могут быстро и правильно писать на нем, а кривые комментарии на английском большее зло чем все остальное
Вопрос касается также и, например, упомянутых здесь логов комита
Будет интересно услышать любые мнения по этому поводу.