Комментарии 27
Я не пурист и не русофил, но мне приятнее и естественнее видеть русский текст в комментариях.
ЗЫ. С английским у меня хорошо.
ЗЫ. С английским у меня хорошо.
Если проект пишется только русскоязычными разработчиками только для русскоязычных — очень логично писать комментарии на русском. Ведь команда устно наверняка общается на русском?
Вообще, имхо, комментарии должны быть на языке общения команды.
Вообще, имхо, комментарии должны быть на языке общения команды.
Я за великий и могучий. У меня с английским не очень, так что тратить время на перевод мне бы не хотелось.
Вы с самого начала говорите: мы будем работать на 1% рынка и никогда и ни за что не будем соваться в остальные 99%. По моему это странный подход.
Я несколько раз сталкивался с тем, чем это кончается: к команде приходят потенциальные партнёры (ивесторы, etc) и просят показать им документацию и примеры кода. Разумеется на английском (если заикнётесь про русский — сразу укажут на дверь). И в результате — имеем недельный аврал, в течении которого команда пытается сделать вид что «так оно и было» и мы типа «всегда только на английском и писали».
Единственный вариант когда такой подход мог бы быть оправдан — для кода, который пишется «на выброс», долго жить не будет и столкнуться с внешним миром ему не суждено. Но тут уже возникает вопрос: а нужны ли в таком коде комментарии вообще?
Единственное исключение: оборонка и госструктуры — и то только там, где закон заставит использовать только российских разработчиков…
Я несколько раз сталкивался с тем, чем это кончается: к команде приходят потенциальные партнёры (ивесторы, etc) и просят показать им документацию и примеры кода. Разумеется на английском (если заикнётесь про русский — сразу укажут на дверь). И в результате — имеем недельный аврал, в течении которого команда пытается сделать вид что «так оно и было» и мы типа «всегда только на английском и писали».
Единственный вариант когда такой подход мог бы быть оправдан — для кода, который пишется «на выброс», долго жить не будет и столкнуться с внешним миром ему не суждено. Но тут уже возникает вопрос: а нужны ли в таком коде комментарии вообще?
Единственное исключение: оборонка и госструктуры — и то только там, где закон заставит использовать только российских разработчиков…
да… верно, этот момент меня как раз и смущал
а если разделить проект на части — скажем, есть какие-то основные вещи — ядро, сервисы, api и т.д —
их документировать как английском…
а части, которые заведомо не будут продаваться, передаваться или имееют временный характер
документировать на русском…
а если разделить проект на части — скажем, есть какие-то основные вещи — ядро, сервисы, api и т.д —
их документировать как английском…
а части, которые заведомо не будут продаваться, передаваться или имееют временный характер
документировать на русском…
Во многих компаниях где я работал было разделение по принципу временное/постоянное: обсуждения, наброски, чат — по русски, всё что попадает в CVS/SVN/P4/etc — только по английски. Если вещь заслуживает штампа «хранить вечно» (а помещение кода в VCS именно это и даёт), то оно заслуживает дополнительных усилий по написанию текста на английском…
Проекты бывают разные, и часто супортом занимается тот, кто написал. И никому эту обязанность/право не передает.
И исходники тоже не передает. В этом случае — кому кроме разработчика важно, на каком языке комментарии?
Многим из вас интересно, на каком языке индусы каментят оракл? Или касперцкий свой КИС?
И исходники тоже не передает. В этом случае — кому кроме разработчика важно, на каком языке комментарии?
Многим из вас интересно, на каком языке индусы каментят оракл? Или касперцкий свой КИС?
комментировать надо на том языке, на котором вы общаетесь устно. Если не общаетесь, то на языке на котором способны более точно и ясно выражать мысли.
НЛО прилетело и опубликовало эту надпись здесь
Unicode — это хорошо. А скрипты, слепленные кем-то 20-30 лет назад — плохо. Но их использование — к сожалению не редкость. Я реально сталкивался с тем, что русские буквы пройдя через американский офис назад не возращались. В последнее время это уже редкость, но сказать что такого уже не случается совсем я не могу — последний раз пришлось разбираться с неправильно перекодированным CSV-файлом недели две назад.
Проблемы с кодировкой, это правда. Они, конечно, решаются просто, но не все разработчики одной команды (она может быть временной, не в одном офисе, или вообще из фрилансеров) пользуются одной средой для разработки и кто-то может по незнанию просто игнорировать, что у него вместо коментов крокозяблы. Ну и самособой, после комита/апдэйта кракозяблы невнимательного разработчика будут у всех. Вы скажете, нафига такие разработчики? Но, увы, такова суровая правда жизни.
Есть вероятность, что понадобится documentor, и результат будет отправлен в стан заказчика.
Да и просто, чтобы выдержать стилистику, коментирую всегда на английском.
Есть вероятность, что понадобится documentor, и результат будет отправлен в стан заказчика.
Да и просто, чтобы выдержать стилистику, коментирую всегда на английском.
еще один минус русских комментариев — приходится переключать раскладку для их написания (а потом обратно)
С этой точки зрения венгерская нотация просто ужас разработчика. Страшно подумать, вдруг на нажимание Shift уходит в среднем час рабочего времени 0_0.
по-моему любому человеку писать комментарии будет проще и удобней на том языке, на котором он думает.
Комментарии в коде на английском, а логи коммита на русском.
а почему комментарии на английском?
В смысле в нашей конторе так :-).
Комментарии на английском, потому что, код (и api и документацию) могут читать не только русскоязычные.
А свн на русском, так как в него никто не лезет. Если бы в разработке проекта участвовали не только русскоязычные, то использовали бы английский.
Комментарии на английском, потому что, код (и api и документацию) могут читать не только русскоязычные.
А свн на русском, так как в него никто не лезет. Если бы в разработке проекта участвовали не только русскоязычные, то использовали бы английский.
самый большой минус неанглийских комментариев это постоянно менять раскладку
Я работаю в немецкой компании. Развиваем долго и упорно продукт, который начали писать там.
До сих пор большая часть комментариев, названий функций и переменных — не немецком языке…
так вот наверное они там задумывались когдато «а на немецком ли нам комментировать»… вот я бы хотел чтобы тогда они решили «нет, на английском»…
соотв. и про русский… я думаю никто не может быть уверен в том что через несколько лет в поддержке их когда не будут учавствовать например индусы…
До сих пор большая часть комментариев, названий функций и переменных — не немецком языке…
так вот наверное они там задумывались когдато «а на немецком ли нам комментировать»… вот я бы хотел чтобы тогда они решили «нет, на английском»…
соотв. и про русский… я думаю никто не может быть уверен в том что через несколько лет в поддержке их когда не будут учавствовать например индусы…
Не знаю, за это или против, но у меня вроде как языковое раздвоение личности. Поэтому и комментарии и коммиты пишу на английском. Русские вызывают отторжение. И как-то уже автоматически получается, что при написании комментария голова переключается в английский режим c обязательными глаголами и более строгой структурой предложения. Помогает посмотреть на то, о чем пишу, с другой стороны. =)
Мое мнение, наличие комментов на хорошем английском языке — это конечно не признак профессионального кода, но вот отсутствие их — явный признак непрофессионального кода. Работая около 10 последних лет с чужим кодом из разных стран мира, заметил, что независимо от страны, комменты — почти всегда на английском языке. Принято так, негласный мировой стандарт де-факто, среди программистов-профессионалов…
Если я вижу код с русскими комментариями, то первое впечатление, которое обычно возникает поначалу — «доморощенное ламерство». Уже потом, разобравшись, и видя что код качественный, приходится себе долго доказывать, что код все-таки написан профессионалами… Но это редко, обычно так и оказывается, что такой код написан начинающими.
Где позволительно писать комментарии на русском — это разве что в лабораторных работах в школе. Ну или разве что, как выше написали, в оборонке, но я с этим не сталкивался и не знаю.
В своей практике комментирую каждый класс, каждый метод, даже приватные методы, каждую проперти, каждый прочий артефакт, веду change log по проектам… Также пишу гайдлайны, описания архитектуры, руководства по установке, использованию того или иного функционала, и т.д. (вот кстати разве что эти документы — гайдлайны, описания и руководства — допускаю что можно писать на русском языке, если проект для русскоязычной аудитории).
Но может быть я конечно и неправ… просто в основном на всех крупных проектах попадались такие заказчики, которые требовали всего этого, и мне все показалось логичным. Мировые стандарты, однако, пусть и негласные…
Если я вижу код с русскими комментариями, то первое впечатление, которое обычно возникает поначалу — «доморощенное ламерство». Уже потом, разобравшись, и видя что код качественный, приходится себе долго доказывать, что код все-таки написан профессионалами… Но это редко, обычно так и оказывается, что такой код написан начинающими.
Где позволительно писать комментарии на русском — это разве что в лабораторных работах в школе. Ну или разве что, как выше написали, в оборонке, но я с этим не сталкивался и не знаю.
В своей практике комментирую каждый класс, каждый метод, даже приватные методы, каждую проперти, каждый прочий артефакт, веду change log по проектам… Также пишу гайдлайны, описания архитектуры, руководства по установке, использованию того или иного функционала, и т.д. (вот кстати разве что эти документы — гайдлайны, описания и руководства — допускаю что можно писать на русском языке, если проект для русскоязычной аудитории).
Но может быть я конечно и неправ… просто в основном на всех крупных проектах попадались такие заказчики, которые требовали всего этого, и мне все показалось логичным. Мировые стандарты, однако, пусть и негласные…
Зарегистрируйтесь на Хабре, чтобы оставить комментарий
Комментирование кода русским языком