Как вы пишете комментарии к коду? / Хабрахабр

leventov 12.04.12 в 21:19

–1

Очень удивился, не найдя такого опроса.

edogs 12.04.12 в 21:22
+25
не вполне понятно. В тэгах «английский язык», однако 2 вариант подразумевает скорее kommentariy na latinice, translitom, rather than «in english».
- leventov 12.04.12 в 21:24
  –4
  А за что тогда голосовать французам, немцам, испанцам, норвежцам и т. д.?
  - vitalikk 12.04.12 в 21:34
    
    +2
    Думаю, можно было бы разделить на три варианта транслит-латиница-английский, если уж вы хотите охватить всю аудиторию.
    
    ИМХО французы-немцы-испанцы-норвежцы — это исключительно маленькая часть аудитории данного ресурса.
    - leventov 12.04.12 в 21:41
      
      0
      
      На транслите никто не пишет :) А иммигранты в Скандинавию или Германию есть.
      - vitalikk 12.04.12 в 21:45
        
        0
        
        Думаю, что можно было бы сделать разные пункты и проверить-таки теорию на практике, раз уж взялись ;)
        
        Или вам интересно будут ли проблемы с кодировками при принудительном переводе всех на Юникод?)
        
        leventov 12.04.12 в 21:52
        
        +8
        
        Прежде всего, хотелось выяснить относительную распространенность двух «школ» комментрирования:
        
        Пишем только на русском, нехрен выпендриваться, важна максимальная понятность.
        
        Пишем только на английском, думаем на английском, достигаем гармонии с ЯП, компилятором и Джошуа Блохом и Линусом Товальдсом.
        
        Остальным пренебрег ради простоты опроса.
        
        edogs 12.04.12 в 21:57
        
        0
        
        Пишем только на русском, нехрен выпендриваться, важна максимальная понятность.
        Не вполне можем согласиться с подобной трактовкой.
        Английский все же стандарт де-факто, русские комментарии сразу режут раз в 10 возможную аудиторию разработчиков. Это важно и при продаже американцам, и при поддержке проекта индусами, да и вообще. Выпендреж-то тут при чем?
        
        Кстати, любопытно, те кто использует русские комментарии, названия функций тоже пишут как function dobavlyauNovoyStatistikeEdinichku?
        
        vitalikk 12.04.12 в 21:58
        
        +2
        
        Я так в школе на Паскале писал.
        
        SVlad 12.04.12 в 22:42
        
        +4
        
        Не скажу за всех, но у нас комментарии на русском, а названия методов по английски. Иногда в комментариях для сложных терминов пишется и русский и английский вариант.
        
        VolCh 13.04.12 в 02:11
        
        0
        
        Не обобщайте. Обычно если такие названия функций дают, то комментарии не пишут. И правда, зачем, когда и так понятно, что добавляют новой статистике единичку :)
        
        valiorik 13.04.12 в 13:08
        
        0
        
        .NET радует возможностью писать названия переменных, методов, классов и т.п. на русском. Пару раз писал из баловства, чтобы позлить коллег.
        
        vitalikk 12.04.12 в 21:57
        
        0
        
        Вторая школа однозначно будет засорена транслитом и «скандинавами», поэтому сравнение некорректно. Или я неправильно понял вашу идею, и вы просто проверяете по-русски или не по-русски комментарии пишут?
        
        leventov 12.04.12 в 22:06
        
        +1
        
        Не предполагал и с трудом верится, что кто-то может писать именно на транслите. На говнокоде тоже не сталкивался. Вы знакомы с такими людьми? Скандинавов, при всем уважении, ничтожный процент на Хабре. Поэтому не думаю, что результаты будут сильно засорены.
        
        Думал, что победит вариант «по-всякому», т. к. сам так пишу, на втором месте — русский. А результат пока противоположный.
        
        edogs 12.04.12 в 22:11
        
        0
        
        На транслите пишут слабо знакомые с англ.языком, при условии что им лениво переключать раскладку или они работают в команде с интернациональными разработчиками, которые постоянно портят им их русские комментарии записанные в cp1251:)
        
        Balthasar 12.04.12 в 23:01
        
        +2
        
        Я встречал кусок г… кода с комментариями на русском в cp1251, русском в UTF-8, русском в чем-то ещё навечно превратившемся в "???? ????? ?????", транслитом (причем кривым транслитом) и на ломанном английском. Всё это в сорцах одной и той же софтины.
        
        VolCh 13.04.12 в 02:12
        
        0
        
        И какие вам больше понравились? :)
        
        Balthasar 13.04.12 в 11:19
        
        0
        
        Больше всех мне понравился этот:
        
        // filtr dla filtracii otrisovki obratnogo lucha
        
        :)
        
        silvansky 13.04.12 в 09:54
        
        +2
        
        Особенная жесть — это когда в одном файле кириллические комменты в разных кодировках…
        
        nekt 20.04.12 в 14:27
        
        0
        
        Это не жесть. Жест когда приложение выводит инфу и в сз1251 и в utf8.
    - arkady 14.04.12 в 03:19
      
      +1
      
      Я бы сделал так:
      
      1. На родном языке, национальным алфавитом
      2. На родном языке, латиницей
      2. На английском
      3. На языке страны-работодателя
      
      Вроде как все охвачены. И хоть норвежцы или испанцы в этом опросе вряд ли появятся, но составитель опроса проигнорировал аудиторию стран СНГ, которых на хабре явно не мало.
  - Lockal 12.04.12 в 21:38
    
    +17
    Комментарии на норвежском? Да шоб таким программистам пришлось такой код разбирать:
    
    /** * これはクラスのコメント */ public class FooClass implements Fooable { /** * オブジェクトのインスタンスを作成する */ public FooClass() { } ... }
    - newpavlov 12.04.12 в 21:47
      
      +5
      
      Так всё же кристально понятно и без всяких гугло-транслейтов. :)
      > Это комментарий к классу
      > Создание экземпляра объекта
    - valerypride 12.04.12 в 22:58
      
      +10
      
      Это ладно, вот что бывает когда японцам надо писать комменты на японском и английском:
      
      Это комментарий из кода с которым мне пришлось работать когда еще жил в японии. Если читать на японском, в комменте написано batterichekku, то бишь проверка батарейки.
      
      Пояснение: батарейка на японском звучит batteri. Однако японцы в большинстве своем не знают английский, иногда даже буквы (чем они занимались в школе? черт его знает, наверное мангу под партой читали). Плюс для японского уха звуки р и л звучат одинаково, поэтому получается вот такая чертовщина :) И это не единственный пример, 90% кода такое.
      - valerypride 12.04.12 в 23:02
        
        0
        
        комменты на японском и *код на английском
        
        shmaltorhbooks 12.04.12 в 23:54
        
        +3
        
        а что, было бы божественно:
        公共の静的関数へのアクセス () { }
        
        valerypride 13.04.12 в 00:04
        
        0
        
        Если создадите такой язык, тысячи японских программистов скажу вам спасибо, как минимум :)
        
        Dair_Targ 13.04.12 в 00:25
        
        +6
        
        Java supports UTF-8 in identifiers.
        
        Agent_Smith 13.04.12 в 00:49
        
        +7
        
        .Net кстати тоже.
        
        Stdit 13.04.12 в 07:28
        
        +4
        
        Даже php 5.4, чего уж там.
        
        НЛО прилетело и опубликовало эту надпись здесь
        
        valerypride 13.04.12 в 07:21
        
        0
        
        Это только идентификаторы. Все остальное тоже на японский переписать. К слову, английский в Японии это действительно очень серьезная проблема, и такой язык программирования очень помог бы японским школьникам приобщиться к занятию. Надо мне подумать над этой мыслью.
        
        akzhan 13.04.12 в 08:42
        
        0
        
        Лучше не надо. Русско-основанные языки программирования уже давно притча во языцах. Аналогично будет и с японско-основанными, полагаю.
        
        Да что говорить, даже японский Ruby вполне англо-основан.
        
        al_bozo 13.04.12 в 14:22
        
        0
        
        К синтаксису того же одинэса привыкаешь недели за три. Отвыкаешь еще быстрее. Так что это видится проблемой только со стороны.
        
        Lockal 13.04.12 в 08:57
        
        0
        
        en.wikipedia.org/wiki/Non-English-based_programming_languages
        
        По слову japanese очень много вариантов. Правда, ссылки уводят на японскую википедию, но a вы чего хотели? :)
        
        PSyton 13.04.12 в 18:55
        
        0
        
        VC в VS2005 спокойно компилил что-то вроде:
        
        class Класс { Класс() { std::cout << "Hello world"; } };
        
        Volfram 13.04.12 в 01:19
        
        0
        
        alias sum ∑
        В D так баловались, припоминаю :)
        
        newpavlov 13.04.12 в 06:48
        
        0
        
        В Go, тоже поддержка есть:
        
        package main import "fmt" func テスト() { fmt.Println("こんにちは世界") } func main() { テスト() }
        
        iboneh 13.04.12 в 09:30
        
        –1
        
        Вот вы смеетесь, а если бы компания 1С родилась в Японии, все именно так бы и было.
        
        silvansky 13.04.12 в 10:16
        
        +1
        
        1C для японцев =)
        
        мой вариант для индусов:
        
        डीईएफ़ फू(): प्रिंट("नमस्ते दुनिया");
        
        Losted 13.04.12 в 12:36
        
        +1
        
        У них зачастую как-то также на английском получается.
        
        torbasow 15.04.12 в 13:30
        
        +1
        
        Для деванагарипишущих. Индус — это религиозная принадлежность. Ория, например, в подавляющем большинстве индусы, но письменность у них своя, а их 35 миллионов.
        
        xiaose 15.04.12 в 04:02
        
        0
        
        а как тебе такой код: goo.gl/lQjLw :)
        
        shmaltorhbooks 15.04.12 в 13:55
        
        0
        
        почему sql-запросы не переведены?)
    - andreishe 13.04.12 в 13:53
      
      0
      
      SDK и примеры для нинтендовских платформ, особенно новых, состоят из такого чуть менее, чем полностью. Комментарии либо на японском, либо пострипаны. Документации почти нет.

IkaR49 12.04.12 в 21:23

+1

В процессе — на русском. Когда уже работа подходит к концу (или по завершению модуля/метода) — перевожу на английский.

vitalikk 12.04.12 в 21:35
+4
А не лень? Или есть свободное время?
- soomrack 12.04.12 в 21:42
  +2
  Комментарии от этого только улучшатся.
  
  PS: если проект делается для себя или в полностью русскоязычной команде, то на русском (это наш язык и нам на нем общаться удобней всего). Если в команде есть иностранцы, то все комментарии обязательно на английском.
- IkaR49 12.04.12 в 22:02
  +6
  Лень. Просто неимоверно лень!
  Но это — как заставлять себя делать зарядку по утрам.
  - Xao 13.04.12 в 06:38
    
    0
    Я всё каждое утро собираюсь начать зарядку делать, ага.
    
    По теме, как правило, на русском, но, если требуется от задачи, то на английском.
Maccimo 13.04.12 в 00:17
+1
Сизиф гордится вами!

Doomsday_nxt 12.04.12 в 21:24

+2

А какая собственно разница? Если в команде все говорят на одном языке — то пишем на родном, если на разных — то на английском.

leventov 12.04.12 в 21:26
+7
Я например пишу короткие комментарии на английском для однородности текста и из лени переключать раскладку. Некоторые, насколько я знаю, принципиально пишут только на английском. Нюансы есть.
- Londeren 12.04.12 в 21:29
  –10
  punto switcher
  - leventov 12.04.12 в 21:34
    
    +12
    ДЛЯ СЛАБАКОВ
    
    Вообще, не использую именно потому, что очень раздражают ложные срабатывания при кодировании.
    - SVlad 12.04.12 в 22:44
      
      +9
      
      У меня автозамена пунтосвитчера отключена. При необходимости вызываю его горячей клавишей. Очень удобно.
      - leventov 12.04.12 в 22:53
        
        0
        
        Не больше ли возни чем собственно переключения раскладок? :)
        
        SVlad 12.04.12 в 23:04
        
        +3
        
        Обычно я раскладки переключаю сам именно потому, что научить пунтосвитчер опознавать программный код невозможно. Но, если я начал набирать не в той раскладке, то, вместо того, что бы всё стирать, я жму pause (кнопка смены раскладки в Puntoswitcher) и введённый текст заменяется.
        
        hostadmin 12.04.12 в 23:05
        
        +1
        
        Так одно дело выделить тест и нажать кнопку, чем выделить, нажать, написать заново
        
        leventov 12.04.12 в 23:10
        
        –1
        
        «Кнутик» в виде «сложного» исправления совершенствует мой слепой набор.
        
        shmaltorhbooks 12.04.12 в 23:56
        
        +1
        
        там можно настроить, чтоб он сам по себе ничего не делал, а при нажатии горячей клавиши перекодировал введенный текст в другую раскладку. если бы не эта его возможность — отказался бы вовсе от него :)
    - hostadmin 12.04.12 в 23:03
      
      –1
      
      Ничего, СЛАБАКИ добавляют редактор в исключения пунто свичера :)
      - SVlad 12.04.12 в 23:06
        
        +2
        
        Иногда код пишется и в документы офиса, и в jabber. Так что исключения не помогают на 100%.
Self_Perfection 12.04.12 в 23:11
+2
А через 2 года оказывается, что неплохо заопенсорсить результат, но упс — с русскоязычными комментариями он никому не нужен.
- Doomsday_nxt 12.04.12 в 23:30
  +2
  Ну и фиг с ним с результатом, если только из-за коментариев он никому не нужен :-)
basilisk 12.04.12 в 23:15
0
Точно такой же логикой руководствовалась и наша контора (головной офис в Германии), пока не начали отдавать дальнейшую разработку в оффшор и выходить на меджународный рынок.

Тут-то и выяснилось, что документация и комменты на немецком не есть гуд для разработчиков, а немецкие интерфесы, локали, трейсы, сообщения об ошибках — для клиентов.
- Doomsday_nxt 12.04.12 в 23:30
  0
  Увы. Сразу делать мультиязычным софт, который не планируется для международного рынка — часто очень накладно.
  - shmaltorhbooks 13.04.12 в 00:01
    
    +2
    можно подробнее с этого места? как по мне — это вопрос самодисциплины разработчиков как по отдельности, так и команды. если один начинает писать в проекте int avtonomnayaRespublikaKrym = 1249, то тимлид должен при code-review намекнуть, что это чушь. и товарищи по работе также должны подсказать, что транслит в именах переменных — муветон. не знаешь перевод какого-то слова — google translate вроде как бесплатный. аналогично и с комментариями, хотя там сложнее в том плане, что написать текст на английском сложнее, чем найти имя для переменной. но всё решабельно при желании.
    - Doomsday_nxt 13.04.12 в 00:03
      
      0
      
      Это то тут при чём? Уже все давно пришли к соглашению, что все названия переменных, методов, классов и т.п. пишутся безисключительно на английском языке.
      - shmaltorhbooks 13.04.12 в 00:05
        
        0
        
        вот и я о том же. растолкуйте, пожалуйста, ваши слова «очень накладно».
        
        Doomsday_nxt 13.04.12 в 00:07
        
        +2
        
        Я про мультязычность текстовых строк, сообщений об ошибках, документации и т.п. Можно конечно сразу всё это делать на английском, но смысл, если изначально пользователь — русский?
        
        shmaltorhbooks 13.04.12 в 00:14
        
        0
        
        кроме документации — всё вышеперечисленное можно делать в utf8 и на английском. во время выхода продукта на международный рынок можно заплатить еще одну зарплату человеку, который работал над проектом и который переведет документацию на английский. я до сих пор не вижу серьезных поводов не делать изначально на английском. исключения составляют продукты, которые пишутся под узкоспециализированные нужды одного конкретного предприятия, не имеющего офисов за границей или даже в других городах — проекты такого уровня зачастую пишутся вовсе без документации, что, в принципе, нисколько не влияет на мою точку зрения. тем не менее, я, поработав в двух таких компаниях, стараюсь писать комментарии и там на инглише изначально.
        
        Doomsday_nxt 13.04.12 в 00:30
        
        +2
        
        Т.е. делать интерфейс программы ИЗНАЧАЛЬНО предназначеной для российского рынка — на английском языке?
        
        НЛО прилетело и опубликовало эту надпись здесь
        
        Doomsday_nxt 13.04.12 в 00:31
        
        0
        
        Вариантов куча. Например отдельный класс, с методом (методами) возвращающими строку по идентификатору. В дальнейшем переделать этот класс под любой из методов хранения различных локалей проще :-).
        
        НЛО прилетело и опубликовало эту надпись здесь
        
        grossws 13.04.12 в 00:41
        
        +2
        
        В большинстве языков есть готовые средства интернационализации, а то и локализации. В С/C++ часто используют gettext, C++/Qt — свой механизм, в Java i18n представлен ResourceBundle'ами. И т. д., и т. п.
        
        Они позволяют довольно дешево подготовиться к интернационализации программы. С локализацией чуть сложнее, но тоже реально. Средства в библиотеках той же Java есть изначально.
        
        НЛО прилетело и опубликовало эту надпись здесь
        
        grossws 13.04.12 в 01:27
        
        0
        
        Подготовка почвы.
        
        Например, в случае gettext все наблюдаемые (предназначенные для вывода) строковые литералы на английском обрамляются в вызов специального макроса _("...").
        
        В сборку добавляется дополнительный этап генерации *.po-файлов, которые определяют маппинг исходных строковых литералов на локализованные сообщения. Полученный *.po-файл отдается переводчику.
        
        Это, конечно, только часть локализации. Но существенно лучше, чем ничего.
        При локализации
  - basilisk 13.04.12 в 01:04
    
    0
    Изначально делать мультиязычным — да накладно.
    
    Но немного подумать программистам и ПМам— не очень дорого. А подумав приходят мысли, что:
    * писать комментарии на английском — неплохая идея. Не весь мир разговаривает на русском, немецком или китайском. А английский язык — всё таки стандарт де-факто. Все программисты (в нашем случае) прекрасно им владеют.
    * заворачивать любые статические строки в макрос _T (я сейчас про C++) — может пригодиться в куче случаев. Хотя бы при переходе на юникод.
    * при работе с датами может закрасться идея, что не во всех странах одинаково даты пишут. Не нужно эту идею прогонять. Реализовывать необязательно, но хотя бы предусмотреть, что возможны и другие варианты.
    и т.д. сходу всё и не перечислю.
    
    Подобные вещи стоят недорого. Но могут избавить от кучи головной боли.
    
    Слава богу, что в C++ не получается сделать немецкие названия классов/методов/переменных. Умляуты компиляторы не любят. А то были преценденты с MS Access базой с кучей макросов на VB. Увы, он гораздо толерантнее к использованию национальных языков в программировании.
    
    Сорри, упоминанием про локали, документацию и интерфейсы я всё это увёл в оффтопик, но моё мнение по поводу основной темы простое: только английский.
    
    И вот почему:
    — вышеозвученная проблема про интернациональные команды разработчиков. С учётом идущих процессов глобализации заявочки вида «мой продукт будут всегда писать программисты здесь и только для этого рынка» выглядят наивно.
    — ненастроенные локали на удалённых серверах: далеко не факт, что сервер, стоящий хрен знает где, сможет показать красивый листинг без крякозябр.
    — да и банальная лень щёлкать раскладками клавиатуры :) у меня моментами их вообще по 3-4: английская, намецкая, русская, белорусская.
    
    Разумеется, моё мнение произрастает из простого факта, что 100% знакомых мне программистов обладают приличным знанием этого языка. В других случаях, возможно, стоит подумать.
    - Nickel3000 13.04.12 в 01:20
      
      0
      
      Мысли сходятся, интересно. Ниже почти то же самое написал, но на 6 минут позже. Радует такой подход.
    - VolCh 13.04.12 в 02:24
      
      0
      
      100% знакомых мне программистов обладают приличным знанием этого языка.
      
      Сейчас работаю над проектом, который писал немец. Вернее втянулся в багофикс его проекта. Так вот после нескольких ляпов мы договорились с ним, что я пишу на русском, а он на немецком везде. Иначе Google Translate мои «английские» комментарии на немецкий «криво» переводит, а его «английские» — на русский. Исключения только примитивные случаи вроде // #12345 workaround.
      - ArtRoman 14.04.12 в 13:47
        
        0
        
        Так с немецкого надо не на русский, а на английский переводить, разница будет колоссальная.
НЛО прилетело и опубликовало эту надпись здесь

vitalikk 12.04.12 в 21:35

+7

Пишу на английском, заодно и практика какая-никакая.

НЛО прилетело и опубликовало эту надпись здесь
- vitalikk 13.04.12 в 01:27
  +3
  Мне нужен брат-близнец, а его все нет.
  - sagod 13.04.12 в 01:41
    
    +2
    Не совсем близнец, скорее сущая противоположность.
    - vitalikk 13.04.12 в 01:48
      
      +3
      
      Ну, это будет злой брат-близнец.
НЛО прилетело и опубликовало эту надпись здесь

ploop 12.04.12 в 21:40

+3

Эх, комментарии…
Код надо учиться писать хорошо, КОД!!!
(эт я про себя, если что) :)

tbicr 13.04.12 в 00:05
+2
В книге Фаулера «Рефакторинг» существование коментариев ставятся под сомнение в пользу читаемого кода, так что Вы не одиноки.

StrangeAttractor 12.04.12 в 21:50

+14

Что значит на латинице/кириллице? На английском!

CAJAX 12.04.12 в 21:54

+14

… и только на английском.

Flying 12.04.12 в 21:56

+12

Только на английском, даже если пишу для себя. Изначально — потому что в tasm на спектруме не было кириллицы, затем потому что постоянно приходилось работать с европейцами, а сейчас уже привык :)

vitalikk 12.04.12 в 22:00

+2

Кстати, а почему в тегах только 1С стоит из ЯП? Опрос проплачен? ;D

elw00d 12.04.12 в 22:38

+7

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

karech 12.04.12 в 22:45

0

Вообще не программист (учусь абсолютно в другой сфере), но последнее время стараюсь писать комменты к функциям/переменным в своем коде, причем переменные и комменты стараюсь писать на английском (если не знаю подходящего слова — пользуюсь переводчиком, но не использую транслит). Хоть мой код никто не увидит, все-равно какая то неприязнь к использованию транслита/русских названий в переменных.

Nickel3000 13.04.12 в 01:10
+3
А зачем вообще нужен транслит? Только для экономии при использовании UTF-8? Ведь это усложняет читаемость для русскоязычных пользователей, а для не владеющих русским это вообще ад, даже словарем не воспользуешься. А любой разработчик просто обязан владеть английским, хотя бы на среднем уровне (мне привычнее немецкий), иначе как читать ту же литературу, которую на русском хрен найдешь?

А если с кодом придется работать другим людям? Что не знающий русского человек сделает с комментарием "/* tut perekhod v nachalo voyd mein*/" :)? Никому же не понравились комментарии на японском, так зачем создавать те же проблемы для других пользователей?

Английский — стандарт де-факто, и так проще всем, если вы подразумеваете развитие проекта в будущем, так что с karech абсолютно согласен, транслит — зло.

lightman 12.04.12 в 22:47

+2

Чаще всего на русском ввиду печального знания письменного английского. Понимаю, что это неправильно.

НЛО прилетело и опубликовало эту надпись здесь

dikkini 12.04.12 в 23:00
+1
не надо так переживать, все комментарии в опенсурсе на английском.
- НЛО прилетело и опубликовало эту надпись здесь
  - dikkini 13.04.12 в 00:16
    
    –1
    Зачем читать код написанный китайцами? Откуда ты знаешь что это китайцы писали? У нас опен сорс пишут онли в китае?
    - НЛО прилетело и опубликовало эту надпись здесь
      - НЛО прилетело и опубликовало эту надпись здесь
  - VBart 13.04.12 в 01:15
    
    0
    А вы не читайте китайского кода, от этого аппетит портится. =)
- VolCh 13.04.12 в 02:27
  0
  Не факт.

Zigmar 12.04.12 в 23:29

+12

По-моему это дурной тон — писать комментарии не на английском, как и использования транслитерированных слов или нелатинских символов в самом коде. А еще хуже — смесь. Буквально недавно работая над одним проектом с российской коммандой, долго чесал в затылке, что за номер собаки такой (поле «DogNumber»), пока не выяснилось, что это, оказывается — номер договора. :))

VolCh 13.04.12 в 02:28
+2
Что лучше, не написать комментарий в нужном месте или написать его на русском?
- Zigmar 13.04.12 в 12:02
  +2
  Лучше написать на английском, а еще лучше написать код так, что бы комментариев не требовалось.
  - VolCh 13.04.12 в 19:22
    
    0
    Если мой англйский таков, что понять его могут только те, для кого русский родной и изучал английский только в советских школах и вузах. Смысл писать на англйском, если его поймут только русские, и то не факт?
    - Zigmar 14.04.12 в 05:24
      
      0
      
      Думаю, что не настолько. Если вы не вчера начали заниматься программированием, то базовый технический английский вы знаете. Слова returns, updates, allocates, и т.д. — вы тоже точно знаете, как и базовый набор предлогов :) Для начала хватит, сочинения ведь писать не надо, а потом это уже дело практики.
      - VolCh 14.04.12 в 14:13
        
        0
        
        Слово return знаю, а когда надо s ставить — нет. В общем переводчики автоматические из моего английского делают бессмысленный набор русских слов. А когда ими перевожу русский, то получаю тот же набор английских слов но с другими окончаниями и/или в другом порядке.
        
        Zigmar 14.04.12 в 14:26
        
        0
        
        Мда… Тогда может лучше и по русски. Хотя подтянуть английский до уровня, что бы уметь строить предложения оно не сложно и никогда в жизни не помешает…
        
        VolCh 15.04.12 в 14:07
        
        0
        
        Для меня субъективно сложно. Нет фидбэка, некому контролировать правильно ли я предложение составил. Хотя бы просто на бинароном уровне «да/нет».
        
        Zigmar 15.04.12 в 15:24
        
        0
        
        Поверьте, вы не первый и не последний. Обучение языкам не вчера придумали, и далеко не все (включая меня) имеют склонность с изучению языков. Но вариантов масса — от занятий самому (для базовой граматики больше и не надо) до курсов, репетиторов и обучающих програм. Но все равно главное — практика. 80% базы английского я набрал не из школы и не из дополнительных занятий а из компьютеров, просто принципиально не пользуясь локализированными играми и софтом.
        
        VolCh 15.04.12 в 19:33
        
        0
        
        Базовой грамматики английского для выражения более-менее сложной русской мысли не хватает, особенно если активный словарный и грамматический запас русского языка немного выше уровня «афтар, убей себя ап стену». А большинство комментариев, необходимость которых чувствуешь, вываливаются за рамки простых мыслей — код или название переменной/функции/метода говорят сами за себя (для них я не «брезгую» гугловским переводчиком воспользоваться) в простых случаях, а в сложных — базовой не хватает.
        
        Причём, имхо, большинство комментариев к коду и/или коммитам даже в проектах людей с нативным английским требования базовой грамматики грубо нарушают. Меня учили, что всегда в английском языке на первом месте подлежащее, на втором сказуемое и уж дальше всякие дополнения и обстоятельства. А на деле видишь комменты типа «fixed issue #12345»
        
        То, что практика главное — полностью согласен. Но практика должна быть с фидбэком, иначе толку от неё мало. Что полезного в том, что я буду писать комментарии на «рунглише» и никогда не узнаю правильно ли я это написал и понимают ли меня англоговорящие люди хотя бы на том уровне, как я понимаю кавказцев или коряков, русский знающих очень поверхностно?
        
        Причём пассивные знания пользы практически не приносят. Навыки чтения/понимания очень слабо пересекаются с навыками письма/говорения. Вроде даже научно доказанный факт — разные области мозга активизируются. Я даже по русскому языку сужу — читать и понимать вполне могу, а писать и говорить грамотно — нет, увы :(

grishkaa 12.04.12 в 23:33

+4

А где вариант «не пишу»?

з.ы. в случае необходимости писал бы на английском.

dikkini 13.04.12 в 00:17
0
Пишите только «для себя»? А если потом дорабатывать надо будет?
- oWeRQ 13.04.12 в 01:57
  +2
  Я, например, пишу комментарии только если код делает то, что может показаться излишним или если это хак, еще, возможно, заметки, на что стоит обратить внимание в случае переработки фукционала. Описывать другими словами то, что можно понять из названия функции и названий переменных, считаю лишним, усложняющим чтение кода.

incogn1too 12.04.12 в 23:34

0

Латышскоязычная команда, но комментарии только на английском, как и все доки.

ncix 12.04.12 в 23:41

+2

Стал писать на английском, т.к. QtCreator частенько подвисает при переключении раскладки. Известный баг и до сих пор не починили.

G3kas 13.04.12 в 10:10
+1
баг прям как фича…

de1vin 12.04.12 в 23:41

+4

Увидев вместо варианта «На английском» вариант на латинице, так и захотелось сказать:

Ego scripto comments Latine

edelweard 12.04.12 в 23:58
+4
Если позанудствовать, то «Scribo commentarios Latine». :-)
- de1vin 12.04.12 в 23:59
  0
  Возможно. Вы что имели ввиду?
  Я имел ввиду фразу: «Я пишу комментарии на латинице».
  - edelweard 13.04.12 в 00:03
    
    0
    Я имел в виду фразу «Я пишу комментарии на латыни», т.е., видимо, то же самое. Просто чуть-чуть грамматику поправил, поэтому и написал, что занудствую ;)
    «Ego» обычно опускается; «писать» — «scribo», а не «scripto», что, наверное, может означать «писать скрипты» :-) Про слово «комментарий» уточнил в словаре.
    - de1vin 13.04.12 в 00:09
      
      0
      
      Я в латинице — полный профан. Читаю словарь только, когда совсем делать нечего… Даже в марио поиграть не хочется :)
      Но на сколько я знаю «Ego« пишется в том случае, когда употребляется местоимение я с большой букв (Я).
      «scribo«, а не «scripto» — скорее всего вы правы. А вот насчет «commentarios» мне честно говоря кажется будет на русском звучать не как «комментарий», а как «комментирую».
      - edelweard 13.04.12 в 00:30
        
        +6
        
        Я имел удовольствие изучать латынь в школе. Уже давно не обращался к этому языку, но тогда это действительно было большое удовольствие. Язык поразил своей стройностью, логичностью и упорядоченностью. Приятно было с вашей подачи вспомнить хоть что-то, поностальгировать ;)
        
        «Ego» — действительно «я». Но обычно местоимения не употребляются, а субъект определяется окончанием глагола.
        «commentarios» — Accusativus Pluralis (винительный падеж множественного числа) от «commentarius» (http://linguaeterna.com/vocabula/show.php?n=9311): ответ на вопрос «пишу что?».

sky_lord 12.04.12 в 23:51

+1

Только на английском, в т.ч. длинные комментарии на много строк, поясняющие что тут вообще происходит и зачем. Первая и основная причина — лень переключать раскладку. Английский у меня отнюдь не идеальный, ошибок полно, но себя я точно пойму, так что ОК. :-) Опять же — работать иногда приходится на разных компьютерах и ОС — раскладка может переключаться по разному (сам привык с детства к Control-Shift) и не хочется думать об этом. Код бывает под виндой, бывает в никсовом терминале — когда очень давно писал комментарии на русском, частенько сталкивался потом с проблемами с кодировками и сам же не мог свои комментарии сходу прочитать. :-) Ну и не нужно забывать, что большая часть технических терминов — кальки и/или транскрипции с английского — смысл их писать на русском? И стандарта перевода нет, так что теоретически то, что я называю одним словом по-русски, кто-то может называть другим… В общем, на английском проще и надежнее.

surly 12.04.12 в 23:55

+1

Смотря где я этот код пишу. Если это что-то крупное, что пишется в IDE на рабочем месте — комментарии пишу по-русски. А если это мелкий скрипт, который пишу прямо на Unix-сервере в vim'е — то по-английски. Потому что иной раз на сервере вообще поддержка кириллицы не установлена, или настройки терминальной программы какие-то дикие в плане перевода кодировок.

DobroeZlo 12.04.12 в 23:59

+4

Честно говоря очень удивлен количеству пишущих комментарии на русском. Я думал английский — это стандарт для всех.

edelweard 13.04.12 в 00:09

+3

Не стал голосовать, т.к. нет варианта «на английском».
Вариант «на латинице» не эквивалентен, т.к. люди могут писать транслитом, чтобы избежать проблемы с кодировками, хотя читаться это будет, конечно, плохо.
Но согласен с большинством комментаторов, что писать комментарии не на английском — как-то странно.
Код может быть использован (сейчас или впоследствии) иноязычными разработчиками; да и вообще, это дополнительная практика в английском. Технический английский очень прост (в сравнении с литературным), не вижу причин не писать комментарии понятном всем языке.

leventov 13.04.12 в 00:26
+2
Мда. К тому же я не учел, что в Прибалтике используется латиница. Явно лучше были бы варианты «На родном языке», «На английском».

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

Простые комментарии стараюсь «зашивать» в длинные названия переменных и методов.
VolCh 13.04.12 в 02:32
0
да и вообще, это дополнительная практика в английском.

Давно убедился, что в таких вещах лучше самостоятельно (без фидбэка) не практиковаться. Первая мысль об этом появилась при прочтении «Дети капитана Гранта».

code_monkey 13.04.12 в 00:22

–2

А почему нет варианта «Не пишу комментарии совсем»? Код должен быть самодокументирован. Максимум — описываю тип аргументов, которые ожидаются в методе, если параметр — масив.

leventov 13.04.12 в 00:31
+1
Максимум — описываю тип аргументов

На каком языке? :)

Не любой код может быть самодокументирован. Будьте осторожны в следовании этой идее.
- code_monkey 13.04.12 в 00:53
  0
  Objective-C. Понятно, что, как и с любым правилом, тут нужно без фанатизма. Но, отсутствие такого варианта не порадовало.

skywatcher 13.04.12 в 00:24

+2

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

sanzstez 13.04.12 в 00:48

+1

Некоторые «веселые» компиляторы, вроде nc30 не воспринимают нормально кириллицу, приходится писать или КАПСОМ или же англоязычный каммент. Исторически сложилось стараюсь максимально писать пояснение на буржуйском.

bagyr 13.04.12 в 00:58

+1

Насущный вопрос: всякого рода docstrigs и прочий JavaDoc за комментарии считаются?

kmike 13.04.12 в 01:12

+3

Перешли с комментариев на английском на комментарии на русском. Не дело это, в стартапе замедлять работу команды из-за каких-то абстрактных возможных проблем при передаче проекта иностранцам. И по-русски-то написать понятный и недвусмысленный комментарий — искусство; почитать бы, что «англичане» из опроса пишут) Поэтому в проектах используем русские комментарии (к коду и коммитам). Сам код (имена переменных и тд) — по-английски на английском языке, никакого транслита, понятно.

Много раз встречал русские проекты, где комментарии к коммитам принято на английском писать было — обычно это выраждается в какие-то огрызки, а не комментарии к коммитам, вплоть до «fixed bug» или «update». При этом написать нормальный комментарий к коммиту по-русски обычно не проблема, и при наличии личного примера все довольно быстро лениться перестают и начинают писать понятно по собственной инициативе, без всяких административных мер.

Опыт продажи был — ничего страшного, потратили пару дней да перевели большую часть. Можно было, впрочем, и не переводить, код и без комментариев понятным должен быть, да и комментариев не по делу стараемся не писать (хочешь покомментировать кусок кода? а может лучше его в функцию или метод вынести и назвать понятно?).

Если уж вести проект на английском — то чтоб все артефакты были на английском полностью (баг-трекер втч), иначе толку-то.

По-моему категоричное неприятие комментариев на русском — зашоренность. В каждом конкретном случае лучше смотреть, как лучше, догмы — это плохо; обстоятельства разные бывают. И на русском-то не всегда удается мысль выразить понятно, что уж об английском говорить. Я, например, достаточно свободно читаю английский текст, но осознаю, что читаю его все же медленнее, чем русский; чтение английского требует больше внимания и напряжения, и вероятность что-то упустить или не так понять тоже выше. При программировании и так много на чем концентрироваться нужно — лучше, чтоб больше «внимания» на реальную задачу оставалось. Пишу на английском тоже довольно много и достаточно свободно, но осознаю, что делаю ошибки при этом, и скорость, конечно, меньше. Зачем же заранее на команду этот груз вешать, как понадобится — так и разобраться. Короче, лучше плюсы и минусы взвешивать, бывают ситуации, когда продуктивнее русский, бывают — когда английский.

grossws 13.04.12 в 01:37
+3
Если программист не может мысль «выразить понятно» на естественном родном языке, то как он код-то пишет?

Так и рождается код, который непонятен даже его написавшим.

OnYourLips 13.04.12 в 01:15

+4

После того, как я работал с китайским, финским и итальянским кодом твердо отвечу: в моих проектах все только на международном языке. За русские комментарии подчиненных линейкой(не настоящей) по пальцам.

Volfram 13.04.12 в 01:20

0

Когда пишу код, думаю по-английски.

MechanisM 13.04.12 в 01:31

+3

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

Inquisitor 13.04.12 в 03:49

0

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

Int_13h 13.04.12 в 04:11

+1

На английском со словарем (с). Просто попадаются среды разработки, не тянущие кириллицу в принцыпе, вот такая суровая жызнь у не-PC непрограммистов.

Stdit 13.04.12 в 04:48

+3

Сдвиг парадигмы!

процедура ГЛмояУдалитьКонкретныеЗначенияИзТЗ(тз,яКолонка,яУдаляемоеЗначение,Условие=0) Экспорт 

// Universal procedure: deleting values from table
// delete from table "тз" column "яКолонка" all values "яУдаляемоеЗначение"
// You can delete range of values. Use: "<=" ">=" ">" "<" "<>"
// Example:  яУдаляемоеЗначение=5 Условие= "<=" will remove all values less than 5

        Если Условие=0 Тогда
                Если ТипЗначенияСтр(яУдаляемоеЗначение)="Строка" Тогда
                        Для Индекс=1 По тз.КоличествоСтрок() Цикл
<...>

Evgin 13.04.12 в 06:31
0
public enum ExpType {
РАВНО(1, «Равно»),
НЕ_РАВНО(2, «Не равно»),
ПУСТО(3, «Пусто»),
БОЛЬШЕ(4, «Больше»),
МЕНЬШЕ(5, «Меньше»),
БОЛЬШЕ_ИЛИ_РАВНО(6, «Больше или равно»),
МЕНЬШЕ_ИЛИ_РАВНО(7, «Меньше или равно»),
МЕЖДУ(8, «Между»),
ПОХОЖЕ(9, «Похоже»),
ПОХОЖЕ_БЕЗ_РЕГИСТРА(10, «Похоже без регистра»),
НЕ_ПОХОЖЕ(11, «Не похоже»);
/*… */
}

Код на русском языке Джава =) обошлись без комментариев =)

Piom 13.04.12 в 05:25

0

А почему нет варианта «Не пишу комментариев@? мой код не нуждается в комментариях, тут понятно и ежу.
А вообще конечно пишем на англицком.

Eddy_Em 13.04.12 в 08:41

0

Для себя комментирую на русском. То, что выкладываю на гуглокод — комментирую либо на английском, либо на обоих языках сразу.
Причем делать английские комментарии стал сравнительно недавно, когда народ, попытавшись прочитать мой код на гуглокоде, испугался «кракозябр», которые возникли на месте моих комментариев по причине того, что гуглокод — на юникоде…

silvansky 13.04.12 в 10:19
0
А я стараюсь изначально в юникоде файлы делать.
- Eddy_Em 13.04.12 в 11:54
  0
  Юникод в консоли читать неудобно: less|enconv?
  - silvansky 13.04.12 в 12:01
    
    +1
    У меня консоль как раз cp1251 плохо выводит, а с utf8 проблем нет.
    - Eddy_Em 13.04.12 в 12:35
      
      0
      
      А при чем здесь 1251?
      - silvansky 13.04.12 в 12:36
        
        0
        
        Это к примеру. К сожалению, эта кодировка живее всех живых, даже в кроссплатформенных проектах. =(
        
        Eddy_Em 13.04.12 в 13:01
        
        0
        
        Да не, у меня классика — КОИ8-Р.
        
        silvansky 13.04.12 в 13:12
        
        0
        
        Это ещё куда ни шло…
        Но у меня был исходник, в котором разные разработчики писали комменты на русском но в разных кодировках. Это вообще жесть была.
        
        Eddy_Em 13.04.12 в 13:33
        
        0
        
        Да уж…

Beholder 13.04.12 в 10:04

–2

Для настоящей интернационализации — надо писать на эсперанто :)

Fragster 13.04.12 в 10:30

0

Я и код на кириллице пишу в 99% случаев

dzigoro 13.04.12 в 11:10

+1

На работе русский проект целиком, документация генерится по javadoc, поэтому проектное требование — комментарии только на русском. А в своих проектах везде на английском.

cyberbobs 13.04.12 в 11:26

+1

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

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

neithere 13.04.12 в 16:41

+1

В FOSS-проектах везде только английский и точка.

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

При выводе куска проекта в открытый доступ перевожу всё там на английский.

asolntsev 13.04.12 в 23:36

0

Мы всегда пишем комментарии только по-английски.
Хотя бы одной простой причине: у нас в Эстонии программистами работают и эстонцы, и русские, и всякие другие товарищи.

А вот в университетах часто учат не только писать комментарии на эстонском, но и называть переменные, методы, классы и колонки в базе данных эстонскими словами. Так что приходится студентов переучивать.

На эту тему есть много забавных случаев: например, когда в банке колонка «остаток счёта» много лет называлась EEK (т.е. эстонские кроны), а потом внезапно Эстония перешла на евро. А эту колонку уже все-все-все используют. Или я встречал два одинаковых метода, но с разными названиями — одно по-русски, другое по-эстонски. В общем, корки отмачиваются ещё какие.

Как вы пишете комментарии к коду?

Аккаунт

Разделы

Информация

Услуги

Приложения