?

Log in

No account? Create an account
 
 
23 Январь 2008 @ 22:44
Комментарии в исходном коде  
Сегодняшние дискуссии на канале gamedeff побудили меня создать небольшой опрос, дабы выявить точку зрения френдов. Собственное мнение по данному вопросу тоже имею, но не буду пока что его разглашать, дабы не агитировать и не вносить сумятицу в стройные ряды :)
Итак.

Опрос #1126229 Язык комментариев в исходном коде (С++/C#/...)

Вы пишете комментарии?

На русском языке (или на другом родном языке).
35(14.9%)
На английском (так как мой код читают специалисты, не владеющие русским).
64(27.2%)
На английском (из принципа или просто так).
86(36.6%)
Когда как (или затрудняюсь ответить).
32(13.6%)
А зачем вообще нужны комментарии в коде? Код должен читаться и без них!
18(7.7%)
Метки: ,
 
 
Местонахождение: home
 
 
 
ex_alexeych on Январь, 23, 2008 20:33 (UTC)
Сначала хотел выбрать английский, ну как-то так сложилось.... но подумов проголосовал за последний вариант. От меня будут пинать ногами =))))

Но вообще-то код действительно должен читаться без комментариев, да и по жизни те комментарии что пишу, либо пояснение алгоритма, либо ссылки на архитектуру. В общем к коду отношения на самом деле и не имеют. =)
Дядя Димаddima on Январь, 23, 2008 20:45 (UTC)
Ну, скорее это меня будут пинать ногами, когда я завтра вечером опубликую свою точку зрения :)))))
А позиция "скажи нет комментарию" мне хорошо знакома и в ней тоже есть свои здравые мысли.
(no subject) - rr_vespertinus on Январь, 23, 2008 21:36 (UTC) (Развернуть)
mfingermfinger on Январь, 23, 2008 22:10 (UTC)
2-й варіант, бо:
1) Коментарі - це частина коду. На якій мові код, на такій і коментарі.
2) Так, читають. А іноді навіть і самі пишуть.
Дядя Димаddima on Январь, 23, 2008 22:19 (UTC)
Цілком згодний.
Хоча мені зручніше все-таки російська мова
(no subject) - mfinger on Январь, 23, 2008 23:37 (UTC) (Развернуть)
belaz_ru on Январь, 23, 2008 23:02 (UTC)
Поясню почему выбрал "на русском".
Вообще-то - на английском (для doxygen). И большая часть кода отдельных (кроме доксигеновских хедеров) комментариев не содержит (или содержит типа "строчка комментов на крупный блок"). Но есть такие места, к которым комментарии после недолгого размышления были написаны по-русски, и при этом размером порядка 10 строк :-)
Причина - есть в логике весьма неочевидное место, в котором ошибки не было, но выглядело так, как будто она возможно была. После внимательного изучения и проверки отсутствия ошибки был написан мегакомментарий, который аккуратно и точно поясняет, почему код выглядит именно так и почему ошибки там нету. А вообще - на английском, да!
3bep on Январь, 23, 2008 23:25 (UTC)
Зависит от языка ТЗ. Комментарии чаще всего представляют собой цитаты или конспективное изложение ТЗ.
ex_vkuskov on Январь, 24, 2008 04:53 (UTC)
На русском. А что гайдзины не поймут если что - это проблемы гайдзинов.
zerostackzerostack on Январь, 24, 2008 06:12 (UTC)
Не надо сильно пинать ногами! я за "На английском (из принципа или просто так)." :)

Причем, раньше (!), точка зрения отличалась.
Подобный же вопрос обсуждал с другими специалистами компании, буквально два месяца назад, разрабатывая прототип.
kmmbvnrkmmbvnr on Январь, 24, 2008 06:48 (UTC)
А где вариан - на русском, потому что код будут читать люди плохо знающие аглицкий?
Дядя Димаddima on Январь, 24, 2008 07:02 (UTC)
Там в первом пункте "два в одном" ))). На самом деле неявно подразумевается, что комментарии на русском - они для удобства восприятия теми, у кого английский не является родным языком.
ex_waker976 on Январь, 24, 2008 07:14 (UTC)
всегда на английском (причина варьируется от проекта к проекту).
а еще в vim неудобно писать в двух раскладках, т.к. command mode в русской раскладке работает ток на половину, а удерживать altgr тоже как-то не привык :)
проголосовал за [2]

зы: а чего постинг для openid запрещен?
Дядя Димаddima on Январь, 24, 2008 07:36 (UTC)
> зы: а чего постинг для openid запрещен?
это как? вообще ничего не запрещал при опросе.
(no subject) - ex_waker976 on Январь, 24, 2008 07:48 (UTC) (Развернуть)
deemetrius on Январь, 24, 2008 07:39 (UTC)
За не имением подходящего варианта решил не голосовать.
Щитаю, что коментария в коде должно быть поминимуму. Но он дожен быть там, где к примеру, использование трёх-этажного шаблонного класса не очевидно. Так в коменте и надо написать
// класс служит для того-то, пример использования такой-то
А на каком языке -- это уже зависит от задания.
Я стараюсь писать коммент на английском, но чтобы пояснить для себя лично то на русском (типа кому надо тот поймёт по-русски).
Не кинокритик. Не палеонтолог.plakhov on Январь, 24, 2008 07:55 (UTC)
Очень близко к моему варианту.
Я тоже решил не голосовать.
Ruslan Kosolapovgrundik on Январь, 24, 2008 08:22 (UTC)
Я выбрал "на английском, потому что будут читать другие люди". На самом деле есть ещё причина - потому что с английским нет проблем с кодировками, а с русским - есть. Вообще, с английским проще и в поиске. То есть "... потому что будут читать другие люди, а также не люди", так будет точнее. Комментарии нужны же не только для того, чтобы понимать, что код делает (для этого комментариев действительно не надо), но и для того, чтобы ориентироваться в незнакомом коде (в том числе и на незнакомом языке - я понимаю, что специфика геймдева такова, что там язык по большей части один, но есть и другие отрасли, где языков используется куча).
Max Kirillovmax630 on Январь, 24, 2008 12:00 (UTC)
> с английским проще и в поиске

у меня наоборот, как ни ищешь какой-нибудь target или тому подобное, так постоянно на комментарии напарываешься.
Семушин Вячеславphp_coder on Январь, 24, 2008 08:36 (UTC)
"На английском (из принципа или просто так)."

Сам считаю, что чем больше комментариев тем лучше и проще разобраться.
Max Kirillovmax630 on Январь, 24, 2008 08:59 (UTC)
> На английском (из принципа или просто так)

конкретно то что я сейчас делаю, могут редактировать минимум в 3 разных кодировках

вообще много комментариев не люблю, для человечьего текста есть комменты к коммитам, багтрекалка и прочая документация. обычно в комментариях что-нибудь нетривиальное описываю
unsigned long int128jerom on Январь, 24, 2008 09:09 (UTC)
А мне как раз кажется, что не всегда 'прочая документация' обновляется своевременно. А вот коммент поправить в совсем не сложно.

Потому я за doxygenы и javadocи и за большое количество комментов. Вплоть до пихания кусков ТЗ прям рядом с кодом.
(no subject) - max630 on Январь, 24, 2008 09:40 (UTC) (Развернуть)
(no subject) - vivkin on Январь, 24, 2008 14:08 (UTC) (Развернуть)
(no subject) - max630 on Январь, 25, 2008 04:12 (UTC) (Развернуть)
(Удалённый комментарий)
mfingermfinger on Январь, 24, 2008 10:27 (UTC)
http://gamedeff.com/paradigm.html

Читай: "#gamedeff - элитарный нах клуб. в него принимаюццо и приглошаюццо толька хуяторы геймдева. то исть ниабхадимым (но не дастаточным!) условием являецца занятасть хуятара в какой-нибудь геймдев-канторе"
Cat beingmatpuk on Январь, 24, 2008 10:16 (UTC)
На английском еще и потому, что разнообразие русских кодировок вообще и у каждого девелопера на машине в частности приводит к феерическому набору символов в исходниках в итоге.
Серегаpap0nt on Январь, 24, 2008 10:36 (UTC)
"На английском (из принципа или просто так)."

это Серега Миронов.