18 мая 2009 г.

Комментируем по-русски

С недавних пор мы начали писать все комментарии в проекте по-русски. Все начиная от XML-комментариев, заканчивая комментариями к коммитам.

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

Что произошло? Можно сказать свершилась моя голубая мечта. Раньше частенько попадались немногословные комментарии к коммитам типа change, delete junk, fix bug. Сейчас все пишут развернутые комментарии! Бывает даже в несколько предложений. Например, "HtmlHelperExtensions - добавил создание статического листа InquiryUnitDropDownList для отображения списка единиц измерения в заявке на продукт"

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

8 комментариев:

  1. Анонимный18 мая 2009 г., 14:58

    Если в команде все знают русский язык и продукт будет поддерживаться рускоязычнми, то конечно так и нужно делать. И в коде можно называть переменные и методы по-русски. Знаю одну питерскую контору, которая делает бухгалтерский софт, так для них использование русского прямо глоток воздуха. Не нужно париться с переводом бухгалтерских терминов на аглицкий.
    ...У нас так не получится. Только на английском языке. А то датчане не поймут :))

    ОтветитьУдалить
  2. Да, я слышал про трудности перевода бухгалтерских терменов =)
    А ваши датчане читают комментарии в проекте?

    ОтветитьУдалить
  3. Ммм а у меня база SQL написана на русском языке :) и ORM для нее C#-овский. И как не странно все работает, единственное что программировать сложновато - но спасает IntelliSense.

    ОтветитьУдалить
  4. @Дмитрий, на шарпе можно спокойно писать на русском, он вроде как юникод поддерживает:)

    ОтветитьУдалить
  5. Анонимный22 мая 2009 г., 0:10

    >> А ваши датчане читают комментарии в проекте?

    Обязательно читают! :)
    А если говорить о xml-коментах, так они же в документацию собираются.
    Читают читают :)

    ОтветитьУдалить
  6. А что послужило причиной такого перехода? Описанный выше эффект ожидался, или он получился побочным?

    Конечно, это зависит от специфика работы, но сам я бы никогда не принял такого решения. Ведь никогда не знаешь, кто будет работать с твоим кодом через несколько лет. Я вот сейчас сижу отлаживаю код немецкой компании, которая несколько лет назад не подозревала, что у нее откроется филиал в России. Очень раздражает, что приходится отвлекаться на переводчик.

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

    ОтветитьУдалить
  7. @Idsa
    Мы перешли на русские комментарии специально, чтобы они были более развернутыми.

    > Надеюсь, в твоей команде не начали создавать переменные вроде "massiv"?

    Нет, переменные мы по-русски и в транслитерации не называем :)

    ОтветитьУдалить
  8. Когда-то на заре программистской молодости работал в проекте для шведских заказчиков. Так один товарищ на русском писал не то, что комментарии (это то еще нормально), но и вывод в лог, причем с матом. Пришлось потом чистить...

    ОтветитьУдалить