Модераторы: LSD

Поиск:

Ответ в темуСоздание новой темы Создание опроса
> Выбор языка для комментариев, в русскоязычных проектах 
V
    Опции темы
 
На каком языке вы пишете комментарии в русскоязычных проектах?
русский [ 13 ]  [38.24%]
английский [ 16 ]  [47.06%]
другой [ 2 ]  [5.88%]
по-разному (желательно пояснить) [ 3 ]  [8.82%]
Всего проголосовавших: 34
В этом опросе возможен один вариант ответа
Гости не могут голосовать 
Данкинг
Дата 16.11.2010, 21:29 (ссылка) | (нет голосов) Загрузка ... Загрузка ... Быстрая цитата Цитата


Yersinia pestis
****


Профиль
Группа: Завсегдатай
Сообщений: 8302
Регистрация: 7.11.2006
Где: მოსკოვი




Цитата(mes @  16.11.2010,  21:01 Найти цитируемый пост)
можно выделять блоки другими средствами.. в том числе и пустыми строками..

Ну, по-моему, написанное всё же красноречивее, чем пустые строки.  smile 


--------------------
There's nothing left but silent epitaphs.
PM MAIL WWW   Вверх
Zloxa
Дата 16.11.2010, 21:32 (ссылка) | (нет голосов) Загрузка ... Загрузка ... Быстрая цитата Цитата


Чо?
****


Профиль
Группа: Завсегдатай
Сообщений: 3473
Регистрация: 12.9.2008




Цитата(azesmcar @  16.11.2010,  20:18 Найти цитируемый пост)
а не доводилось работать в компаниях, где с кодом работает не один единственный человек, а несколько групп (причем из разных стран), а проект состоит из нескольких сотен мегабайт? Читаю ответы и такое ощущение, что код пишется исключительно для себя. 

А зачем лезть в чужой код?
Я так полагаю, если идет коллективная разработка, то достаточно четко распределяются зоны ответственности. Разработчики друг другу выставляют интерфесы(функции там или классы), вот их описывать - обязательно. Особенно всякие ньюансики использования или же ограничения применения. Однако ж мне думается, описыать интерфес взаимодействия модулей предпочтительнее не коментариями в коде, а техническим дизайном и не по факту, а пре фактум. Тогда комментарий в коде выражается ссылкой на регламентирующий этот код документ, чего более чем достаточно.

Добавлено через 2 минуты и 26 секунд
Кстате, в делфийских сорцах VCL дофига коментариев?
Я ковырял ораклиные продукты. Их там тоже нет.

Мировой беспрактис, фигли!


--------------------
Достоверно известно, что 89% людей доверяют статистике взятой с потолка smile
PM   Вверх
mes
Дата 16.11.2010, 21:37 (ссылка) | (нет голосов) Загрузка ... Загрузка ... Быстрая цитата Цитата


любитель
****


Профиль
Группа: Участник Клуба
Сообщений: 7954
Регистрация: 14.1.2006




Цитата(Данкинг @  16.11.2010,  20:29 Найти цитируемый пост)
Ну, по-моему, написанное всё же красноречивее, чем пустые строки.    

иногда (иль даже часто) красноречие отвлекает.. 
комменты нужны для передачи смысла целого блока в одной строчке.. 
а дублировать строку плохой смысл..
т.е. такой код с комментариями
Код

// начало цикла
for (size_t i=0; i<10; ++i)
{
  // начало цикла
  for (size_t i=0; i<10; ++i)
  {
  }
  // конец цикла
}
// конец цикла
// начало цикла
for (size_t i=0; i<10; ++i)
{
}
// конец цикла

выглядит очень удручающе.. 

Это сообщение отредактировал(а) mes - 16.11.2010, 21:37


--------------------
PM MAIL WWW   Вверх
Zloxa
Дата 16.11.2010, 21:39 (ссылка) | (нет голосов) Загрузка ... Загрузка ... Быстрая цитата Цитата


Чо?
****


Профиль
Группа: Завсегдатай
Сообщений: 3473
Регистрация: 12.9.2008




Цитата(Zloxa @  16.11.2010,  21:32 Найти цитируемый пост)
Я ковырял ораклиные продукты. Их там тоже нет.

Вспомнил, в интерфейсной части - есть. Описание правил вызова. Я частенько туда смотрю.


--------------------
Достоверно известно, что 89% людей доверяют статистике взятой с потолка smile
PM   Вверх
Данкинг
Дата 16.11.2010, 21:39 (ссылка) | (нет голосов) Загрузка ... Загрузка ... Быстрая цитата Цитата


Yersinia pestis
****


Профиль
Группа: Завсегдатай
Сообщений: 8302
Регистрация: 7.11.2006
Где: მოსკოვი




mes, не просто "начало цикла", а "начало/конец заполнения таблицы TABLE", например.


--------------------
There's nothing left but silent epitaphs.
PM MAIL WWW   Вверх
azesmcar
Дата 16.11.2010, 21:42 (ссылка) | (нет голосов) Загрузка ... Загрузка ... Быстрая цитата Цитата


uploading...
****


Профиль
Группа: Участник Клуба
Сообщений: 6291
Регистрация: 12.11.2004
Где: Армения




Цитата(Zloxa @  16.11.2010,  21:32 Найти цитируемый пост)
Я так полагаю, если идет коллективная разработка, то достаточно четко распределяются зоны ответственности. Разработчики друг другу выставляют интерфесы(функции там или классы), вот их описывать - обязательно. Особенно всякие ньюансики использования или же ограничения применения. 

Не все так идеально на самом деле. Иногда чужой код не работает, а хозяин находиться в другой часовой зоне или вообще уволился. А может его уже лет 10 как нету и этот код столько же лет не трогали, но вот сейчас понадобилось что-то в нем изменить.

Цитата(Zloxa @  16.11.2010,  21:32 Найти цитируемый пост)
Однако ж мне думается, описыать интерфес взаимодействия модулей предпочтительнее не коментариями в коде, а техническим дизайном и не по факту, а пре фактум. Тогда комментарий в коде выражается ссылкой на регламентирующий этот код документ, чего более чем достаточно.

кстати генерация этой документации может происходить на основе комментариев, для этого полно инструментов.

Цитата(Данкинг @  16.11.2010,  21:39 Найти цитируемый пост)
mes, не просто "начало цикла", а "начало/конец заполнения таблицы TABLE", например. 

какая разница? лучше написать один комментарий, объясняющий логику работы цикла. Не забываем, что функция не должна состоять из 150-и строк, так что этого комментария будет вполне достаточно, не надо комментировать каждую строку. Если имя функции подобрано верно, комментарий объяснил логику работы то понять читающему всю логику функции не составит труда. Я никак не понимаю зачем писать что-то типа
Код

// returning x
return x;

?
и ежу понятно, что здесь возвращается x smile зачем это писать? Тем не менее не раз встречал комментарии подобного рода.

Это сообщение отредактировал(а) azesmcar - 16.11.2010, 21:48
PM   Вверх
Zloxa
Дата 16.11.2010, 21:49 (ссылка) | (нет голосов) Загрузка ... Загрузка ... Быстрая цитата Цитата


Чо?
****


Профиль
Группа: Завсегдатай
Сообщений: 3473
Регистрация: 12.9.2008




Цитата(azesmcar @  16.11.2010,  21:42 Найти цитируемый пост)
кстати генерация этой документации может происходить на основе комментариев, для этого полно инструментов. 

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


--------------------
Достоверно известно, что 89% людей доверяют статистике взятой с потолка smile
PM   Вверх
mes
Дата 16.11.2010, 22:08 (ссылка) | (нет голосов) Загрузка ... Загрузка ... Быстрая цитата Цитата


любитель
****


Профиль
Группа: Участник Клуба
Сообщений: 7954
Регистрация: 14.1.2006




Цитата(Данкинг @  16.11.2010,  20:39 Найти цитируемый пост)
не просто "начало цикла", а "начало/конец заполнения таблицы TABLE", например. 

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



--------------------
PM MAIL WWW   Вверх
Данкинг
Дата 16.11.2010, 22:33 (ссылка) | (нет голосов) Загрузка ... Загрузка ... Быстрая цитата Цитата


Yersinia pestis
****


Профиль
Группа: Завсегдатай
Сообщений: 8302
Регистрация: 7.11.2006
Где: მოსკოვი




Цитата(mes @  16.11.2010,  22:08 Найти цитируемый пост)
ну тогда бы хоть кусок кода привели... может для вашей задачи и смотрится

 
Код

////начало перебора файлов с учётом даты
     memo1.Clear;
     FindFiles (filer.Directory,'*.*',memo1.Lines, true);
     ok:=true;
      for j:=0 to memo1.Lines.Count -1 do
       begin
        findfirst(memo1.Lines.Strings[j],1,rec);
        dt:=filedatetodatetime(rec.Time);
        if strtodate(datetostr(dt))>=strtodate(datetostr(dater.date)) then ok:=false;
       end;
     if ok then lister1.Items.Add(filer.Directory);
   ////кончало перебора файлов с учётом даты

Ещё видел, что пишут так:
 
Код

for j:=0 to memo1.Lines.Count -1 do
 begin
 ....
 end;//for j:=0 to memo1.Lines.Count -1 do


Это сообщение отредактировал(а) Данкинг - 16.11.2010, 22:34


--------------------
There's nothing left but silent epitaphs.
PM MAIL WWW   Вверх
kemiisto
Дата 16.11.2010, 23:18 (ссылка) | (нет голосов) Загрузка ... Загрузка ... Быстрая цитата Цитата


Дикий Кот. =^.^=
****
Награды: 1



Профиль
Группа: Участник Клуба
Сообщений: 3292
Регистрация: 29.7.2007




Цитата(azesmcar @  16.11.2010,  16:01 Найти цитируемый пост)
ЕСТЕСТВЕННО НА АНГЛИЙСКОМ.

Бредовые мысли всегда так легко узнаваемы по КАПСУ. Для русскоговорящего человека естественно использовать русский язык.

Цитата(azesmcar @  16.11.2010,  18:18 Найти цитируемый пост)
а не доводилось работать в компаниях, где с кодом работает не один единственный человек, а несколько групп (причем из разных стран)

А не доводилось читать внимательно первое сообщение темы? Речь шла о маленькой локальной поделочке.

Цитата(azesmcar @  16.11.2010,  18:18 Найти цитируемый пост)
Читаю ответы и такое ощущение, что код пишется исключительно для себя.

Читаю твои ответы и такое ощущение, что ты склонен обобщать собственный опыт. 

Цитата(azesmcar @  16.11.2010,  18:18 Найти цитируемый пост)
а зачем вообще нужны такие комментарии?

Ой да ладно!

Цитата(mes @  16.11.2010,  19:01 Найти цитируемый пост)
можно выделять блоки другими средствами.. в том числе и пустыми строками..

Ещё можно не использовать языки в которых нужны какие-то сторонние средства выделения блоков. smile 

Цитата(azesmcar @  16.11.2010,  19:22 Найти цитируемый пост)
Для написания комментариев на английском словарного запаса из 50 слов более чем достаточно.

Нет уж, нафиг. Лучше кракозябры на русском/китайском/... .


--------------------
PM MAIL WWW GTalk Jabber   Вверх
mes
Дата 16.11.2010, 23:55 (ссылка) | (нет голосов) Загрузка ... Загрузка ... Быстрая цитата Цитата


любитель
****


Профиль
Группа: Участник Клуба
Сообщений: 7954
Регистрация: 14.1.2006




Цитата(kemiisto @  16.11.2010,  22:18 Найти цитируемый пост)
Цитата

можно выделять блоки другими средствами.. в том числе и пустыми строками..

Ещё можно не использовать языки в которых нужны какие-то сторонние средства выделения блоков.  

можно.. но даже в обероне, если писать неаккуратно (не добавляя лишние пустоты для разделения) глаз будет напрягаться 
 smile 




--------------------
PM MAIL WWW   Вверх
mes
Дата 17.11.2010, 00:11 (ссылка) | (нет голосов) Загрузка ... Загрузка ... Быстрая цитата Цитата


любитель
****


Профиль
Группа: Участник Клуба
Сообщений: 7954
Регистрация: 14.1.2006




Цитата(kemiisto @  16.11.2010,  22:18 Найти цитируемый пост)
 Для русскоговорящего человека естественно использовать русский язык.

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




--------------------
PM MAIL WWW   Вверх
Sibit
Дата 17.11.2010, 07:05 (ссылка) | (нет голосов) Загрузка ... Загрузка ... Быстрая цитата Цитата


Шустрый
*


Профиль
Группа: Участник
Сообщений: 96
Регистрация: 6.10.2009
Где: NSK




Я думаю, что это сильно от контекста зависит, и в каждый случай нужно отдельно рассматривать исходя из того, кто этот код будет читать. Вот на фига мучать себя англицким, если 90% что читать будешь только ты? А те кто когда-нибудь и сунет нос в код, отлично понимают по русски? Если же ситуация другая, то тогда и смотреть нужно по другому.

PM MAIL   Вверх
azesmcar
Дата 17.11.2010, 07:50 (ссылка) | (нет голосов) Загрузка ... Загрузка ... Быстрая цитата Цитата


uploading...
****


Профиль
Группа: Участник Клуба
Сообщений: 6291
Регистрация: 12.11.2004
Где: Армения




Цитата(kemiisto @  16.11.2010,  23:18 Найти цитируемый пост)
Бредовые мысли всегда так легко узнаваемы по КАПСУ. Для русскоговорящего человека естественно использовать русский язык.

А...ну да, конечно smile 
Русские комментарии, названия функций и переменных на русском..ведь это естественно. Жаль, что большинство компиляторов не поддерживают возможность писать полностью на русском и приходиться писать на транслите. А чтож ты на буржуйском пишешь? Ну создай свой язык и компилятор (полностью русский)..нечего буржуйскими пользоваться.

Цитата(kemiisto @  16.11.2010,  23:18 Найти цитируемый пост)
А не доводилось читать внимательно первое сообщение темы? Речь шла о маленькой локальной поделочке.

А не доводилось подумать о том, что все начинается с маленькой поделочки. Учиться надо делать правильно с самого начала. Это все равно, что сказать "программа маленькая", можно не заботиться о табуляциях и форматировании кода..и так все понятно.

Цитата(kemiisto @  16.11.2010,  23:18 Найти цитируемый пост)
Читаю твои ответы и такое ощущение, что ты склонен обобщать собственный опыт. 

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

Цитата(kemiisto @  16.11.2010,  23:18 Найти цитируемый пост)
Ещё можно не использовать языки в которых нужны какие-то сторонние средства выделения блоков. smile 

Вот это шедевр smile я просто в восторге smile 

Переведи фразу в верхний регистер, раз уж
Цитата

Бредовые мысли всегда так легко узнаваемы по КАПСУ

выбирать язык исходя из этого...я даже не знаю что сказать smile

Цитата(Sibit @  17.11.2010,  07:05 Найти цитируемый пост)
Я думаю, что это сильно от контекста зависит, и в каждый случай нужно отдельно рассматривать исходя из того, кто этот код будет читать. Вот на фига мучать себя англицким, если 90% что читать будешь только ты? 

Ты говоришь мучать - а я говорю писать на естественном для кода языке. Многие термины если и переводяться, то через одно место. Чего стоит "неуправляемый код" smile и смотришь..вроде и правильно перевели, но звучит то как...
И не понимаю, почему многие считают это мучением? Неужели у кого-то настолько плохо с английским, что примитивный комментарий составить без труда не могут? Как же вы тогда вообще программируете?

Цитата(mes @  17.11.2010,  00:11 Найти цитируемый пост)
а так русскоязычному человеку, наверно, естественно программировать на русскоязычных ЯП..

 smile 

Цитата(kemiisto @  16.11.2010,  23:18 Найти цитируемый пост)
Нет уж, нафиг. Лучше кракозябры на русском/китайском/... . 

Ну если твоя конечная цель - это "лишь бы мне было удобно" тогда понятно.

Это сообщение отредактировал(а) azesmcar - 17.11.2010, 08:22
PM   Вверх
Sibit
Дата 17.11.2010, 10:24 (ссылка) |  (голосов:3) Загрузка ... Загрузка ... Быстрая цитата Цитата


Шустрый
*


Профиль
Группа: Участник
Сообщений: 96
Регистрация: 6.10.2009
Где: NSK




Цитата(azesmcar @  17.11.2010,  07:50 Найти цитируемый пост)
названия функций и переменных на русском..ведь это естественно


как ловко ты передергиваешь smile вроде только о комментариях говорят.

Цитата(azesmcar @  17.11.2010,  07:50 Найти цитируемый пост)
Многие термины если и переводяться, то через одно место. 


А если в комментариях нужно использовать термины из предметной области, то что делать? И все спецы по ней только на русском и разговаривают?  Тут как бы, ситуация обратная получается.

Как бы в ветке никто не доказывает, что писать комментариях нужно только на русском, лично я считаю, что есть случаи когда писать на англицком - смысла нет и если ты с ними не встречался, то это не значит, что их не существует.




Это сообщение отредактировал(а) Sibit - 17.11.2010, 10:26
PM MAIL   Вверх
Ответ в темуСоздание новой темы Создание опроса
Правила раздела «Флейм»
Sneg0k

Добро пожаловать в «Флейм».

В разделе не действуют многие правила:

  • Можно оффтопить(умеренно)
  • Можно общаться на темы, не только связанные с программированием.

Строго запрещено:

  • Размещать рекламу
  • Обсуждать политику
  • Оскорблять друг-друга и переходить на личности
  • Наезжать, провоцировать других участников форума
  • Материться
  • Троллить

Напоминаем о существовании волшебной кнопочки "Репорт". Если вы увидели сообщение, несовместимое с жизнью, просьба подвести на нее курсор и клацнуть левой клавишей мышки. Тем самым вы сможете призвать злого, но жутко справедливого джина-модератора, который нашлет порчу на злостного нарушителя. Кстати - счётчик сообщений здесь не растёт.


Глас Винграда:


Глас Философии:


Если Вам понравилась атмосфера форума, заходите к нам чаще! С уважением, Sneg0k

 
0 Пользователей читают эту тему (0 Гостей и 0 Скрытых Пользователей)
0 Пользователей:
« Предыдущая тема | Флейм | Следующая тема »


 




[ Время генерации скрипта: 0.0739 ]   [ Использовано запросов: 23 ]   [ GZIP включён ]


Реклама на сайте     Информационное спонсорство

 
По вопросам размещения рекламы пишите на vladimir(sobaka)vingrad.ru
Отказ от ответственности     Powered by Invision Power Board(R) 1.3 © 2003  IPS, Inc.