Xpoint
   [напомнить пароль]

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

Метки: [без меток]
2004-03-26 00:25:32 [обр] Алексей Шоков(0/9)[досье]
Вопрос конечно риторический, но всё равно порошу высказаться по поводу: на каком языке писать комментарии к коду? На английском, или можно на русском? Или это зависит от того, кто будет читать код в дальнейшем?
спустя 3 часа 8 минут [обр] Владимир Палант(1/4445)[досье]
Вы имеете в виду какой-то конкретный проект? Если есть конкретный проект и конкретные люди, с которыми вы его делаете (сейчас или потенциально в будущем), то с ними вы это и должны решать (или просто следовать нормативам написания кода в фирме). Если вы работаете один, то тут, конечно, все зависит от вашего вкуса. Я бы, правда, не стал бы комментировать на русском уже хотя бы по той причине, что неудобно все время переключать кодировку. Кроме того могут возникнуть проблемы просматривать такой файл (не у всех стоит русифицированная ОС). Ну и, конечно, английские комментарии теоретически сможет понять любой программист, откуда бы он ни был. Но если анлийского у вас как раз хватает, чтобы читать техническую документацию — комментируйте лучше на русском, больше толку будет.
спустя 5 часов [обр] Андрей Новиков(8/1242)[досье]
Хуже нет комментария на ломаном английском. Поэтому, если английский у Вас на уровне, то однозначно он (как уже замечено проблема кодировок, шрифтов, переключения раскладок и т.п., плюс они будут просто в полтора раза короче). Иначе только русский.
спустя 10 часов [обр] Алексей Шоков(0/9)[досье]
Андрей, Владимир, большое спасибо за ваше мнение, вы меня убедили :)
спустя 1 день 6 часов [обр] Дмитрий Котеров(2/912)[досье]

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

  1. Заодно английский и подучите. Разговорная (или письменная, это похоже) практика еще никому не вредила.
  2. Да, поначалу противно (очень противно — сам переучивался), но через пару недель (месяцев?) привыкаешь совершенно.
  3. Пока думаешь, как бы так сформировать фразу, чтобы она была понятна всем, переключаешься на другой род мозговой деятельности — следовательно, отдыхаешь. А в программировании нет ничего более плодотворного, чем передышка (особенно если вошел в клинч с неработающим кодом).

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

спустя 2 часа 36 минут [обр] Владимир Палант(1/4445)[досье]
Дмитрий Котеров[досье]
"Проблема кривых фраз" уже не кажется надуманной, когда пытаешься разобраться в коде, прокомментированом "знатоком" английского. Рекомендую развивать английский как-нибудь иначе.
спустя 2 часа 15 минут [обр] Дмитрий Котеров(2/912)[досье]
По-моему, Вы все же преувеличиваете. Сколько ковырялся в чужом коде, ни разу проблем не было. Да, местами кривизна видна на глаз, но не нестолько, чтобы не понять смысла.
спустя 9 часов [обр] Андрей Новиков(8/1242)[досье]

Хм... Это кто-же комментирует неработающий код? :)

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

спустя 2 часа 46 минут [обр] Дмитрий Котеров(2/912)[досье]
Это кто-же комментирует неработающий код?
По-моему, код лучше комментировать сразу же во время написания. Хотя сам частенько делаю это потом, но такой способ язык не поворачивается назвать правильным.
спустя 5 дней [обр] Frosya[досье]
Если можно высказать свое мнение, то я проголосую за английские комментарии, даже с плохим английским... ;)
Или по крайней мере латинскими буквами.
спустя 2 дня 19 часов [обр] Даниил Иванов(0/63)[досье]
Вообще все зависит от конкретного случая. Если заранее известно, что иностранцы код читать не будут (оборонный заказ, например), то собс-но, писать комментарии на английском сразу становится бессмысленным - разве что чтобы шпионам помочь :)
спустя 2 часа 58 минут [обр] Артём Сапронов aka Capricorn(0/569)[досье]
Даниил Иванов[досье]
ха, подчас в нашем английском никаким шпионам не разобраться, в отличии от грамотного русского :))
спустя 4 месяца 9 дней [обр] Артём Сапронов aka Capricorn(0/569)[досье]
М Перенесено из форума "Прочее"
спустя 2 месяца 10 дней [обр] Андрей Иванов(0/3)[досье]

Докумендацию к продукту пишем на русском.

  1. Мы русские
  2. Документацию в коде не читаем, потому как технологии позволяют не напрягаясь сделать нормальную печатную или какой-нибудь .chm
  3. Исходя из 2) можно перевести документацию хоть на 100 языков

Правда, иногда ломает при чтении документации то по-русски, то по-английски. В смысле, от смены языка ломает.

спустя 9 дней [обр] Alexey V.Zelenin(0/8)[досье]
Андрей Иванов[досье] меж тем иногда встречаются ситуации, когда названия переменных или понятий надо писать по-английски, так как на русский они переводятся крайне криво. Вот и получается разброд - половина предложения на русском, половина - на английском.
спустя 1 месяц 2 дня [обр] Андрей Иванов(0/3)[досье]
Alexey V.Zelenin[досье]
Русский язык небогат в плане компьютерной тематики и здесь много заимствований.
Есть примеры того, что нельзя перевести? У нас это очень большая редкость.
Powered by POEM™ Engine Copyright © 2002-2005