Taras_Serevann
@Taras_Serevann
веб-разработчик, автор

На каком языке писать комментарии в коде?

Уже около года пишу комментарии в коде только на английском языке. С одной стороны, так мой код становится менее понятным людям, которые не знают английский или могут просто не разобрать то, что я написал (sorry for my english и тд.). С другой стороны, писать комментарии на английском модно и круто, сам не знаю почему, все так делают. Так какой же язык выбрать для комментариев? Какой выбираете вы?
  • Вопрос задан
  • 1757 просмотров
Пригласить эксперта
Ответы на вопрос 7
Scorpi
@Scorpi
Ну мне кажется вопрос очевиден, смотря для кого Вы пишете код.
Если вы в команде русскоязычных разработчиков - можно и на русском.
А если какой-то Open Source проект, то конечно лучше бы на международном английском.
Ответ написан
Комментировать
websanya
@websanya
Фронтенд разработчик, подкастер
Удобно писать на английском, потому что для большинства существующих готовых решений это стандарт де-факто. Ну то есть даже терминология английская зачастую будет понятнее, чем русские аналоги, потому что нету нигде единого стандарта как и что переводить.

Но если команда russian-only (это плохо), то можно писать русские комментарии, но тогда нужно какой-то глоссарий использовать, чтобы не было разных интерпртаций одного и того же английского понятия.
Ответ написан
Последнее время часто пишу на обоих.
При этом комменты на английском делаю очень лаконичные, в основном обозначающие суть того, что происходит и для чего. На русском расширенно описываю, например часто добавляю не только что и для чего, но и почему именно так.
Ответ написан
Комментировать
lightalex
@lightalex
Все очевидно же
Для себя - на каком удобнее
Для русских - на русском
Для остальных - на английском
Не уверены кто будет потом после вас - на английском
P.s. немного зла - habrahabr.ru/post/207390 :)
Ответ написан
Комментировать
nazarpc
@nazarpc
Open Source enthusiast
Если Open Source - только английский, если закрытый код - зависит от ситуации, но обычно лучше английский, мало ли кто будет поддерживать потом ваш код.
Ответ написан
Комментировать
SagePtr
@SagePtr
Еда - это святое
На английском - лень по 10 раз переключать раскладку.
Ответ написан
Комментировать
65536
@65536
Присоединяюсь к вопросу. Только беспокоит другое, написать можно и на обоих. А вот реально ли на гитхабе или просто у себя где-то в гите держать параллельно 2 версии, где код идентичен, а комменты на русском. Вот хочу я залить одну прогу на гитхаб и чтобы охват был от русских чайников до всех остальных, но походу постоянно следить за этим будет невозможно, мержить построчно каждый файл и вообще непонятная история будет складываться как минимум в одной репе, а то и в обеих. Единственное, что пока пришло в голову это каждому методу давать номер типа #2743 и чтобы был скрипт, который бы скачал и вставил комменты в нужные места. Можно было бы совместить енг и номерки для дорогих россиян чтобы они могли скачать себе великие и могучие комменты, но это прокатит только для комментов перед методами, а внутри методов тоже бывают. Кто что думает?
Ответ написан
Ваш ответ на вопрос

Войдите, чтобы написать ответ

Войти через центр авторизации
Похожие вопросы