Чем плохи комментарии на русском языке в коде?

Question

[Анна Бакурова]

Коллега спрашивает, чем плохи комменты на русском, моих аргументов не хватает. Напишите Ваши причины их неприязни.

Comments

[h8nor]

Ребята! Считается нормальным вырезать BOM из UTF-8 :/ (ANSI [cp1251 если хотите] AS UTF-8 используется в php, BOM мешает обработке файла как и в других скриптовых языках). Это уже не UTF-8, а CESU-8. Если бы каждый суслик не пытался заниматься сельским хозяйством, проблем бы не было. Стандарты не в USA придуманы. Так что комментарии на русском языке здесь совершенно ни при чём.

Answer 1

[Дмитрий]

За русские комментарии
Во первых это круто

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

В третьих: все нормальные люди уже давно используют utf8, соответственно проблем с кодировкой не будет

В четвертых: пущай пиндосы тоже напрягают свой мозг и учать русский язык (почему русские должны учит ингиш, а англичане и пр. русский яз нет? Дискриминация)

Comments

[Константин Китманов]

> пущай пиндосы тоже напрягают свой мозг и учать русский язык
Вот для этого и придумали эсперанто. Но очередной параноик у власти с примерно такими же идеями угробил и эту затею.

P.S. Проявили бы больше уважения к русскому, раз так болеете за него:)

[Анна Бакурова]

1) не аргумент
2) сомнительный аргумент. Если у Вас данные язык воспринимается как сухой, значит Вы сами не вложили в него больше влажности)))
4) это антиаргумент, языки программирования и так на англ написаны и документации к ним на англ вот самая веская причина. А патриотизм в виде "Русский это круто" можно опустить, так как он из воды состоит на 100%

Выходит единственный плюс это то, что Вы знаете русский на уровне написания комментариев достаточно, а английский нет

[Saboteur]

Американцы не обязаны учить русский. И вы не обязаны учить английский. Но вы можете легко устроиться на работу и получать рубли, без общения с заказчиком из-за рубежа, который готов платить баксы. Все очень просто.

Answer 2

[Роман]

Смотря для кого.
Если для себя коментировать, то пофиг на каком языке.
Если опенсорс и для всех, то принято на английском.

Всегда можно расказать анекдот про комнату с бананом, обезьянами и холодной водой.

Comments

[Евгений Петров]

Про 10 обезьян, вы хотели сказать?)

[Роман]

Евгений Петров: 10 обезьян как итог)

[Котик Антон]

Для тех, кому интересно, что за "анекдот": pritchi.livejournal.com/92886.html

[Евгений Петров]

Роман: Нене, там вся соль именно в 10-ти:) Так сказать, коллективное мышление.
Сначала все знают, почему не нужно лезть за бананом, а после методичной замены всех обезьян никто из них не знает почему, но твёрдо знают, что поступать нужно именно так.

[h8nor]

Евгений Петров: Я бы сказал - вся суть религии ;)

Answer 3

[skvot]

1. Комментарий на русском автоматически повышает порог входа в проект для людей, не знающих этот язык.
2. Визуальная "каша" - код на английском, комментарии на русском.
3. Кодировки и все из этого вытекающее.

Comments

[Константин Китманов]

> Кодировки и все из этого вытекающее.
А что, кто-то еще не пишет в UTF-8?

[Котик Антон]

> Визуальная "каша" - код на английском, комментарии на русском.
Не всегда)
https://en.wikipedia.org/wiki/Non-English-based_pr...
Ну и конечно же 1С

[h8nor]

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

[Анна Бакурова]

Автор может описать действующие проблемы с кодировкой?

[skvot]

Анна Бакурова: самое простое: проект в 1251, кодировка по дефолту в IDE - utf8. Некий программист делает изменение и сохраняет файл в utf - все комментарии теряются.

[Saboteur]

Константин Китманов: да, без UTF-8 еще долго и комфортно могут жить различные скрипты как на боевых железках, так и в консолях серверов.

[Константин Китманов]

Сергей: согласитесь, что такие скрипты пишутся не в КОИ8 или, прости господи, в win1251, а в ASCII, который, в общем, совместим с UTF8.

[Saboteur]

с каких пор ascii, в котором изначально 1байт=1 символ совместим с UTF8, в котором 2байта=1 символ?

[Котик Антон]

Сергей: Правила записи кода одного символа в UTF-8

[Saboteur]

27cm: Что это за ссылка? Какое отношение кодировка UTF-8 имеет к стандарту ASCII, для которого она не подходит? Стандарт ASCII подразумевает использование однобайтных кодировок типа KOI-8, то есть русские символы будут покарежены.

Answer 4

[Денис Инешин]

1. Любой код требует поддержки, раз вы пишите комментарии, значит код будет поддерживаться еще долго и над ним будет работать команда. В международной практике является нормальным явлением, когда команды мультинациональны. В такой ситуации общепринято использовать всем понятный английский язык, который является стандартом в IT. Даже в ситуации когда команда вся русскоязычная, всегда есть вероятность обмена опытом, когда к вам на стажировку приедет иностранный специалист или просто потребуется например продать код другой компании. Так что даже палка раз в год стреляет.
2. Это хорошая практика. Конечно можно обойтись без английского языка, работая программистом в России. Но на самом деле английский очень нужен, чтобы выйти за рамки и стать по настоящему крутым спецом. Как бы много не было материалов, книг, курсов, туториалов на русском, на английском всего этого добра в сотни раз больше и очень высокого качества.

Comments

[h8nor]

Блин, а разве сам код не является мультинациональным языком? ;) Одно дело, когда вы берёте код с комментариями на английском языке, и совсем другое - когда и так английские переменные вы начинаете комментировать на ломаном английском )

[Денис Инешин]

Дѣаволъ: не всегда возможно писать абсолютно читабельный код и лучше корявый английский в комментариях, чем правильный русский, или еще хуже транслит)

[h8nor]

Денис Инешин: про транслит никто не говорил (:

[Денис Инешин]

Дѣаволъ: я кучу раз видел код с переменными вроде: var stolbik = 1, palochka = 2; и т.д.)) так что...

[h8nor]

Денис Инешин: не знаю как вы - я даже не пытаюсь читать транслит; сразу закрываю страницу!

Answer 5

[⚡ Kotobotov ⚡]

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

Answer 6

[Don Kaban]

Тупой вопрос.
Теперь чуть подробнее.
1. Вы знаете английский, в силу профессии
2. Любой, кто откроет ваш код - знает английский в силу профессии
3. Любой, кто откроет ваш код по делу - знает английский в силу профессии.
4. Предполагать, что то, кто откроет ваш код по делу (включая вас) знает не только английский (в силу профессии), а еще и русский (по праву рождения, наследования или от лишней дури) - избыточно.
5. Предполагается, что вы, в силу професси не совершаете избыточных (а оттого - лишних) телодвижений.

Достаточно спросить себя, а отчего я не пишу комментарии на грузинском, нигерийском или наречии 'кок', так распространенном к востоку от великой стены, которую северные варвары называют "китайской"?

Comments

[Анна Бакурова]

Так и не ясно комментатор за англ или рус комментарии.
И в чём состоят подробности... Это вопросы или утверждения вообще?
По количеству комментариев не заметно что вопрос не актуальный.

[Don Kaban]

Как грустно, Анна, что и русский язык вам, видимо - не родной

[Анна Бакурова]

Don Kaban: так аргументировать можете? за и против или только эмоции?
Если Вам интересно почему Я пишу комменты на английском, то по нескольким причинам.
1) международный язык - английский
2) языки программирования на которых Я пишу на английском
3) не нужно менять кодировку при написании кода и коммента
4) в большинстве случаев англ. короче, что позволяет быстрее писать комментарии
5) не все термины языков программирования переведены на русский и выходит что люди привыкли называть mixins миксинами, а не примеси, хотя это один из лучших переводов. Выходит ломанный русский. - таких примеров много

[Don Kaban]

Ой. То есть из моего коммента можно сделать вывод, что я пишу русские комментарии и советую это? Однако.

[Анна Бакурова]

Don Kaban: Я уже написала выше что из Вашего ответа вообще не ясно что Вы хотели сказать написанным.

[Don Kaban]

Увы мне.

[ins52]

лучший ответ. все вопросы после этого сами отпадают.

Answer 7

[four4]

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

Для наших - это нормально и это хорошо.
Так как комментариями обычно прописывают не простые вещи (а иначе зачем комментарии нужны, код должен быть и сам понятным), которые на неродном языке можно и не так понять и не так написать - и получить двойной испорченный телефон.

Answer 8

[Mintormo]

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

Answer 9

[Bob Smily]

Если делаете проект не для себя, пишите комментарии на 2х языках, и все дела

Answer 10

[Андрей Сальников]

Если иметь в виду, к примеру, SCSS - то у меня всегда он конвертирует русские комментарии в кашу.

Comments

[Глюкъ Виртуален]

Это злые происки врагов и всякие прочие санкции.

Answer 11

[Mikhail Osher]

Присоединяюсь к ответу skvot и добавлю:
- комментарии на англ языке выглядят куда лаконичнее.

Answer 12

[Сергей]

Я вообще не пишу комментарии и не имею проблем

Comments

[h8nor]

Вашей памяти можно позавидовать!

Answer 13

[abcd0x00]

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

Comments

[h8nor]

Вы думаете, комментариев на испанском будет меньше, если вы не будете писать комментарии на русском языке? ;)

[abcd0x00]

Не, просто больше людей смогут прочитать мою программу. В сотни раз больше.

[h8nor]

Лично мне проще читать чужой код, чем чужие комментарии :) Побежал учить английский (:

[abcd0x00]

Дѣаволъ:
Вчера искал себе прокси, наткнулся на очередной пример
code.google.com/p/python-proxy
Докстринг, описывающий программу, даже не на испанском, а на португальском.

"Лично мне проще читать чужой код"
Когда его много, читать просто нет времени.

[h8nor]

abcd0x00: В указанном примере 180 строк, из которых половина комментарии (:
Бывает ещё такая ситуация. Читаешь книгу на русском, а комментарии в примерах кода на английском. Вот тогда начинаешь думать, что переводчики ленивые, и нужно искать книгу на оригинальном языке.

[abcd0x00]

Дѣаволъ: Да книги несущественны. Просто тут дело в коллективной разработке. Португалец и русский смогут вместе работать, если пишут на английском оба.