Комментирование Кода На Русском Языке

Вопрос комментировать или не комментировать код мне вполне ясен, я стараюсь придерживаться правил: — код должен документировать себя.

— комментарии ради комментариев ненужны и вредны.

— нужно комментировать то, что может вызвать вопросы: Чтобы выявить такие места, нужно попробовать посмотреть на кусок кода чужими глазами.

— в то же время, если проект по каким-либо причинам требует строгой документации, тогда нужно придерживаться стандартов этого проекта, а не каких-то общих советов.

А вот вопрос, на каком языке комментировать, мне не совсем ясен.

Я никогда не комментировал код на русском языке.

Когда над проектом работают или наверняка будут работать не только русскоязычные разработчики, то вопрос отпадает сам собой.

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

Почему-то у меня и у многих моих коллег, с которыми я работал, резко негативное отношение к русским комментариям в коде, но нормальных аргументов против этого почти нет. И это несмотря на то, что его английский далек от совершенства.

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

Теги: #разработка #программирование #код #английский язык #комментирование кода #Идеальный код #Чулан

Последнее изменение: 2024-10-19 21:10:22

Вместе с данным постом часто просматривают: