вот почему я стараюсь не комментировать на русском

Alexandre

PHPПенсионер
вот почему я стараюсь не комментировать на русском

PHP:
//客户端
void client(){
  carrot::Connection c1(HOST,AMQP_PORT);
  carrot::Channel* ch=c1.open_channel();
  //消息选择器,把这个选择器设置为消息properties的reply_to字段,服务器端才会把
  // 应答消息发回给这个客户端
  string my_selector="example_client";
  MessageProperties mp;
  //设置message_properties的reply_to,服务器端接受到后把此字段放入返回消息的 correlation_id
  mp.reply_to(my_selector);
  ch->publish(GROUP_EX,GROUP_QS,"hahahahaha",10,mp);
  //get的第一个参数是 "队列名#选择器"
  Message response=ch->get(string(GROUP_QC)+"#"+my_selector,true);
  while(response.empty()){
    /*
     * 这里需要一个超时处理,因为Channel#get函数总是立即返回,
     * 当队列里无消息时get返回的Message为空(Message#empty()返回true)
     * 或者用consume方式订阅此队列,即可不用超时处理
     */
    response=ch->get(string(GROUP_QC)+"#"+my_selector,true);
  }
  string result=string(response.body().second,response.body().first);
  std::cout<<"response : " << result << std::endl;
  pause();
}
-~{}~ 01.05.09 20:47:

жаль что форум не смог отобразить японский
 

Gorynych

Посетитель PHP-Клуба
здорово!

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

Да и колорит теряется... Ну, например:

/*
* :IMP: дурацкое название. И дурацкая реализация. Скажем... версия 0.2.
* А что вы хотели в 02:23?!?
*/

или

/*
* П.С Бред, конечно. Чем дальше в лес, тем больше мы будем писать триггеров
* с такими ошибками и внутри обычных классов. И тут возникнет необходимость
* сделать кавайно - выводить только для наших системных классов...
*/

P.S. не помню дословно, но мысль о том, что не стоит каждому IT-шнику демонстрировать собственную ущербность в способности излагать мысли на английском мне кажется очень верной.
 

grigori

( ͡° ͜ʖ ͡°)
Команда форума
Gorynych, попробуй писать в комментах стихи для повышения художественности творения
 

Gorynych

Посетитель PHP-Клуба
grigori я так понимаю, лаконичность помогает вам писать что-то вроде: "this function get data from datebase" - и чувствовать себя полиглотом? Или все еще круче, и мы смело пишем нечто вроде "fucking timeout! skip..." - и считаем себя крутым перцем?
 

weregod

unserializer
Gorynych
пока что интернациональным языком в ойти считается английский

а комментарии на русском я бы оставил для 1С ;)
 

berkut

Новичок
Gorynych чем такой мусор уж лучше вообще ничего. кому нахрен интересен такой гомно-поток сознания? только отвлекает - информации 0.. аки д. донцова, блин
 

Mr_Max

Первый класс. Зимние каникулы ^_^
Команда форума
berkut
Это крик души, так сказать. ;DDDDDDDD
 

berkut

Новичок
Mr_Max крики души оправданы у психолога(в сложном случае - психиатора) или на спец форумах/посиделках идиотов, но никак не в коде - работе.
 

Gorynych

Посетитель PHP-Клуба
"говно-поток сознания" помогает позже отловить, пересмотреть и модифицировать код который был написан в цейтноте или в котором есть сомнения. Отсутствие комментариев или сухие, лаконичные, но формально правильные - просто не дают нужной информации, по той причине, что ты уже не помнишь "кто вот это все здесь понаделал?!?"
 

Lightning

Трудоголик
Если предполагается, что в проекте будут работать только русские/белорусcкие/украинские/... разработчики, то можно и на русском писать. В общем случае - английский. Я пишу на английском: мне просто лень раскладки переключать :D
 

grigori

( ͡° ͜ʖ ͡°)
Команда форума
Gorynych
if you want to follow coding standards or not is fully up to you
whether it per-function comments, English or block padding
nobody cares, it reflects just your salary and recognition
 

Gorynych

Посетитель PHP-Клуба
grigori: idea on wednesday, release on friday, googling first page on monday... Shit! Sometimes i can to read code of my guys only two days later, and I shouldn't kill them for then that they have done
 

MiksIr

miksir@home:~$
Автор оригинала: Gorynych
"говно-поток сознания" помогает позже отловить, пересмотреть и модифицировать код который был написан в цейтноте или в котором есть сомнения. Отсутствие комментариев или сухие, лаконичные, но формально правильные - просто не дают нужной информации, по той причине, что ты уже не помнишь "кто вот это все здесь понаделал?!?"
т.е. с вашей точки зрения это вот:
// это я тут какой-то бред понаписал, потому-что выпил две кружки пива, так что нужно обязательно переписать этот прямой вызов в ДБ на использование ORM, а то потом как что-то переделаем и все кирдык! И не забыть - не пить так много пива перед сдачей проекта!
более информативно, чем
// TODO: переписать на ORM
?
 

Gorynych

Посетитель PHP-Клуба
ОМГ!

MiksIr не знаю, я не пью пиво и не пишу о своих впечатлениях о выпитом пиве. Возможно, если пить пиво и при этом писать код перед сдачей проекта, тогда действительно лучше ограничится просто кратким и емким " TODO: переписать на ORM".

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

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

как уже писал - мы работаем командой, и более чем над одним проектом, между которыми надо быстро-быстро переключаться и быстро-быстро возвращаться обратно. Ситуация при которой в среду появляется идея, которую надо реализовать до пятницы - это не выдумка, а реальная ситуация. В этом смысле мне во сто крат полезнее накидать говно-поток сознания в код, над которым я работал, переключиться на срочную работу, а потом, вернувшись, перечитать и понять, что за мысли бродили в голове? И именно в виде непричесанного говно-потока проще накидать это рядом с тем к кодом, к которому этот поток относится.

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

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

и да, если все ваши проблемы в том, что вы точно знаете, что надо использовать умную абстракцию того Frameworka, на котором вы вроде работаете, но это для вас не так естественно и просто, как хочется, а просто и естественно для вас быстро лупануть пару прямых запросов к бд... Тут и думать не о чем! Ну не получается сейчас написать как хочется (потому что долго и ни фига не интуитивно), так и пишите: "надо переписать на ORM".
 

Фанат

oncle terrible
Команда форума
Круто. Меня окружают полиглоты. По-хорошему завидую.
Комментарии-то я вообще не пишу, но если примерить ситуацию на себя, то читаю-то я более-менее бегло. Но вот когда приходится писать, то это превращается в челеднж. На написание небольшого письма в суппорт уходит минут 20. Чтобы выразить свою мысль на английском, мне приходится думать над построением фразы больше, чем над комментируемым кодом.

-~{}~ 02.05.09 08:55:

Хотя, конечно, тут, как и в любых спорах не земле, подводит разность точек зрения.
Ясно ведь, что у Gorynych речь идет о "внутренних" комментариях, отражающих процесс разработки. И в этом смысле мне очень кажется, что комментарии как раз должны быть потоком сознания. Они будут дополнять код, объяснять, о чем думал человек в этот момент.

Ну а оппоненты пишут исключительно библиотеки для массового распросранения. Ну или не для массового сначала, но ведь раз уж написал шедевр - чего бы его не пустить в люди, бесплатно или лучше за денюшку. А тут уж без комментариев на международном языке, вида "this function get data from datebase" - никак, никак не обойтись. Не поймут-с.
 

fixxxer

К.О.
Партнер клуба
вообще, всегда, когда хочется написать комментарий - надо его сначала написать, а потом подумать:

1) если это комментарий к тому, что делает метод - соответствует ли название метода тексту комментария? как его переименовать, чтобы было понятно и без него?

2) если это комментарий к внутренней логике - как изменить иммена переменных? а может быть, выделить эту логику в отдельный метод, название которого прямо следует из текста комментария?

3) если это комментарий к какой-то служебной переменной - как переименовать переменную или переписать код так, чтобы логика изменений значений переменной была очевидна?

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

weregod

unserializer
к большому сожалению, в тех местах, где абсолютно непонятно, почему было сделано так-то и так-то, комментариев нет вообще
из минусов комментирования по-русски: некоторые комментарии имеют свойство оседать в коде на года, в какой-то момент встаёт вопрос об открытии кода, о его документировании, и кому-то всё равно приходится переписывать их на тот же самый английский
а бюджета на тех-райтера как не было, так и нет ;)
 

Lightning

Трудоголик
fixxxer
Про это Макконнел писал :)

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

Ф а н а т
Кодер в любом случае выражает свою мысль на английском в именах переменных/методов/классов/констант, даже в конструкциях языка :) Согласен? Или ты даешь русские имена английскими буквами?
 

Фанат

oncle terrible
Команда форума
Lightning
Автор оригинала: Фaнат
думать над п о с т р о е н и е м &nbsp; ф р а з ы
язык - это не только отдельные слова и словосочетания. Которые ты используешь для именования операторов.
То, как я буду писать по-английски связные предложения, английским я з ы к о м назвать нельзя все равно. ну и нафиг он тогда нужен?
Если я в комментариях буду писать то же самое, что в операторах, то такие комментарии, как ты сам написал, не нужны. Если это осмысленный развернутый комментарий, а не очередной оператор для phpdoc, то лично я его на английском писать не возьмусь. Без действительно весомой причины, во всяком случае. "Пацаны на форуме засмеют" такой причиной не является.

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

fixxxer

К.О.
Партнер клуба
Ну зависит от уровня, конечно, но я вот совершенно не стесняюсь при необходимости писать простыни, хотя понимаю, что местами кривовато строю предложения, использую не те предлоги, а где использовать a/the до сих пор толком не понимаю =) Зато скилл прокачивается =)

Комментарии на русском меня, кстати, несколько смущают _при чтении_, т.к. когда у меня мозг в programming mode, я мыслю по-анлийски, а лишнее "переключение" на мышление по-русски и обратно заметно выбивает из потока.

Еще один аргумент - когда на произвольно взятом сервере надо быстро что-то подредактировать в vim прямо на проде (а такое бывает при ловле плавающих багов), с большой вероятностью там не настроена локаль, и тупо все едет. Плюс зависимость от кодировки: мне, например, на маке прочитать cp1251 стоит некоторых усилий.
 
Сверху