DeviceManager dev_manager = .....;
DeviceLocation location = dev_manager.FindDeviceLocation(....);
if (location == null) {
location = dev_manager.CreateDeviceLocation(....);
}
BizObject.Location = location;
//BizObject.Update(); не нужно, будет вызван после изменения координат объекта.
Комментарии на русском
Участники форума, как вы считаете, на каком языке лучше писать комментарии в программах русскоязычному программисту?
С одной стороны, английские комментарии будут понятно большему числу людей. Однако, мои программы не предназначены для иностранцев, так зачем же я буду мучать себя и других своих колег? Эту задачу я обычно решаю совсем просто: не пишу комментарии. Но это не всегда хороший выход :)
Тема не очень серьезная и холиварная. Но желательно, чтобы доводы участников темы будут логичными, обоснованными.
С одной стороны, английские комментарии будут понятно большему числу людей. Однако, мои программы не предназначены для иностранцев, так зачем же я буду мучать себя и других своих колег? Эту задачу я обычно решаю совсем просто: не пишу комментарии. Но это не всегда хороший выход :)
Тема не очень серьезная и холиварная. Но желательно, чтобы доводы участников темы будут логичными, обоснованными.
если для программиста читать комментарии на английском - мучение, то тогда он плохой программист. так что только на английском. и обязательно писать. =) или я слишком серьезно ответил? ))
Мне кажется без разницы на каком языке писать (хоть на китайском :)); главное, чтобы другие понимали то, что написано... А то часто бывает так, что ничего не понятно даже из русскоязычного комментария.
Цитата: Washington
так что только на английском. и обязательно писать. =)
А так пойдет:
// Ylya Mooromets' metod
Если я говорю, что метод долго подготавливается (грузится), зато потом хорошо работает?
Цитата: Washington
или я слишком серьезно ответил? ))
Нормально ответил - можно было даже серьезнее.
на английском комментарии лаконичней получаются
Цитата: SergPas
Мне кажется без разницы на каком языке писать (хоть на китайском :)); главное, чтобы другие понимали то, что написано... А то часто бывает так, что ничего не понятно даже из русскоязычного комментария.
ага. ты написал коммент на китайском, потом я стал читать твой код и комменты на китайском мне там нужны как зайцу стоп-сигнал. то же самое. я написал на русском комменты, затем американец стал их читать. вряд ли он че то поймет. а английский он как то универсальный язык для программиста.
а по поводу смысла - ясное дело, что метод ильи муромца не объясняет сути метода. поэтому надо писать нормальные смысловые комменты. вот как то так..
Цитата: Washington
я написал на русском комменты, затем американец стал их читать. вряд ли он че то поймет
Велика вероятность, что американец не поймет мои комментарии на английском.
Для себя пишу - любой язык. Чаще всего (95%) - на русском. Если работа в группе, или "в люди" - исключительно английский.
Еще аргумент. Допустим мы используем что-то вроде Doxygen. Вероятно на больших предприятиях такая последовательность: написал код, сгенерил документацию, подписал у начальников, отнес в архив. Или сгенерил документацию и отдал заказчику. Вот тут могут возникнуть проблемы. Так как большинство современных начальников не понимают английский (или плохо понимают), хотя и говорят, что без него никуда.
Хотя, с Doxygen почти не работал. Возможно, для бумаги он не очень подходит.
Хотя, с Doxygen почти не работал. Возможно, для бумаги он не очень подходит.
Раз твои программы для иностранцев не предназначены,вот и не мучайся–пиши комментарии на русском.В любом случае,на русском ты сможешь гораздо выразительней:) передать своим комментарием идею части кода,чем на английском
Ну а если задумал программу на экспорт,то пожалуйста:хочешь–пиши на английском,хочешь–не пиши вообще:)
Или сделай 2 варианта:сначала на русском,а уж затем на английском
Upd:
"На како[COLOR="Red"]й[/COLOR] языке вы пишете комментарии"–это,конечно,круто:D
Ну а если задумал программу на экспорт,то пожалуйста:хочешь–пиши на английском,хочешь–не пиши вообще:)
Или сделай 2 варианта:сначала на русском,а уж затем на английском
Upd:
"На како[COLOR="Red"]й[/COLOR] языке вы пишете комментарии"–это,конечно,круто:D
не не не. вы че? Во первых мне на английском легче выразить суть коммента да и букв меньше, согласен с оксотником. И универсально. Так что не вижу причин писать их на русском. И вообще. Тема комментариев раскрыта в моем блоге так что ходите туды :)
Дурилы вы все. Матюга на английском не смотрятся, и идею полностью не выразишь...
Так как пишу в основном один, у меня все грустно для читателя - при строжайшем нейминге и детальном форматировании, почти полное отсутствие комментариев, крайне редко бывает что-то в духе
Как я заметил, комментировать нужно не столько код, который я пишу, сколько протокол взаимодействия моих классов. И комментарий здесь подсказывает, почему нет вроде-бы ожидаемого по протоколу вызова Update.
Код:
На работе варианты не рассматриваются, т.к.три четверти людей в проекте (как нижняя оценка) не говорят по русски.
Для учебных проектов в универ - тоже без вариантов, по русски, потому что иначе научруки злятся. + когда комментарии обильные и по русски, можно составлять курсовую, например, на 60% из листингов :rolleyes:
А в том что пишу для себя, для изучения технологий, проверки каких то подходов (эх, время бы еще на все это побольше..) - это или как Hardcase, или краткие комментарии на английском. Лаконичнее. Намного.
Для учебных проектов в универ - тоже без вариантов, по русски, потому что иначе научруки злятся. + когда комментарии обильные и по русски, можно составлять курсовую, например, на 60% из листингов :rolleyes:
А в том что пишу для себя, для изучения технологий, проверки каких то подходов (эх, время бы еще на все это побольше..) - это или как Hardcase, или краткие комментарии на английском. Лаконичнее. Намного.
Я на работе писал комментарии по-русски, иногда с английскими вставками. Плюс для каждого публичного члена класса автодокументирующие комментарии (типа ''' или ///). Последние чаще для себя, поскольку публичных членов немало, плюс они обычно перегруженные, плюс я редко когда помню точные сигнатуры.:)
А вообще комментарии хороши на том языке, который с наибольшей вероятностью будет использован другими программистами данного проекта. Если пишется закрытая внутриконторская прога - нет нужды писать по-английски, а если что-то для более широкого доступа - тогда по-английски лучше всего.
А вообще комментарии хороши на том языке, который с наибольшей вероятностью будет использован другими программистами данного проекта. Если пишется закрытая внутриконторская прога - нет нужды писать по-английски, а если что-то для более широкого доступа - тогда по-английски лучше всего.
Хороший код в комментариях не нуждается разве только на какой-нибудь жестокий алгоритм или на публично торчащие интерфейсные сущности и то больше для порядка, чем для чего-то еще ибо грамотное название классов, методов, функций и их параметров как правило, решают все проблемы. Есть, конечно, маргинальные фетишистские подходы аля процент комментариев от всего исходного текста, но речь сейчас полагаю не об этом. А язык в интерфейсах - английский, а внутренний должен быть тот который проще понимать, ибо, если комментарий появился, значит тут не все так просто. В интернациональной команде с сим порядком сложнее, а посему англицкий наиболее предпочтителен, хоть и не бесспорен.
Могу предположить, что английский знают немного чаще, чем немецкий или французский… хотя тоже открытый вопрос. Тут наверное всё ж лучше исходить из целевой аудитории читателей кода. А комментировать, ИМХО, всяко лучше чем не комментировать. Без фанатизма, конечно.
Пишу на английском как правило. В основном публичные интерфейсы. За английский есть несколько доводов. Если код публичный, то тут все ясно. Всегда есть вероятность что его может почитать человек не знающий русского. А английский в IT все же можно сказать стандарт. Какой то закрытый внутрипроектный код часто тоже может увидеть не шибко русскоговорящий сотрудник. Да и учитывая тенденцию к переиспользованию кода - сейчас нет нужды в английских комментариях, но кто его знает в какой проект попадет этот код через год, два.
Плюс с русскими комментариями есть еще одна немаловажная проблема - кодировки. Поскольку специфика работы такая что как минимум часть кода собирается на совершенно различных операционных системах - это актуально. С одной стороны решение простое, вроде как utf-8 стандарт де факто и нет проблем. Его почти все понимают. Но вот редко встретишь виндового программиста, например, у котрого например IDE настроено на utf-8 исходники. Да и не только виндового - до сих пор есть динозавры, которые koi-8 грешат. А ведь как практика показывает - обязательно кто нибудь возьмет эти исходники, поматериться на автора кучи вопросиков в коментах, исправит что нибудь и ведь так и закоммитит уже вопросики вместо русских комментариев.
Плюс с русскими комментариями есть еще одна немаловажная проблема - кодировки. Поскольку специфика работы такая что как минимум часть кода собирается на совершенно различных операционных системах - это актуально. С одной стороны решение простое, вроде как utf-8 стандарт де факто и нет проблем. Его почти все понимают. Но вот редко встретишь виндового программиста, например, у котрого например IDE настроено на utf-8 исходники. Да и не только виндового - до сих пор есть динозавры, которые koi-8 грешат. А ведь как практика показывает - обязательно кто нибудь возьмет эти исходники, поматериться на автора кучи вопросиков в коментах, исправит что нибудь и ведь так и закоммитит уже вопросики вместо русских комментариев.
Цитата: Kogrom
А так пойдет:
// Ylya Mooromets' metod
Если я говорю, что метод долго подготавливается (грузится), зато потом хорошо работает?
// Ylya Mooromets' metod
Если я говорю, что метод долго подготавливается (грузится), зато потом хорошо работает?
Ну на самом деле если ты коментируешь публичный метод - так и документируй что он делает, и как его использовать. Что параметры означают, что взвращает и т.п. Грамотный нэйминг, как уже упомянул Ramon конечно хорошо, но даже он бывает не всегда очевиден к сожалению. Особенно когда он кажется очевидным автору, а другим уже нет. )
Цитата: Kogrom
Еще аргумент. Допустим мы используем что-то вроде Doxygen. Вероятно на больших предприятиях такая последовательность: написал код, сгенерил документацию, подписал у начальников, отнес в архив. Или сгенерил документацию и отдал заказчику. Вот тут могут возникнуть проблемы. Так как большинство современных начальников не понимают английский (или плохо понимают), хотя и говорят, что без него никуда.
Вобще сколько не использовали доксиген - всегда была проблема как раз чтоб там коменты английские были - ибо это был как правило какой то внешний документ достаточно публичный.
Хотя доводилось и мне работать там, где коментарии требовались исключительно русскоязычные - но там весь код был "строго секретный и закрытый" и не должен был выходить за пределы страны как бы. =)
Хотя вот там то как раз проблемы с кодировками и вылазили во всю. )
Выбрал бы русский для внутриконторных продуктов, но возникают проблемы с кодировками - часто русский коментарий превращается в кракозяблики при открытии файлов исходников в другом редакторе. Так что приходится использовать английский.
Вот про что я и говорю. Когда научатся все utf-8 использовать - тогда да. Но похоже никогда.
При всем уважени к пытливому уму автора, не вижу смысла в данном опросе (окуните меня в холодную воду - мож прозрею).
Каждый делает так, как считает нужным, как удобно ему и тому, кто будет читать код.
Каждый делает так, как считает нужным, как удобно ему и тому, кто будет читать код.
Цитата: Iktomy
не вижу смысла в данном опросе (окуните меня в холодную воду - мож прозрею).
Тема содана в основном, ради этой цитаты:
[QUOTE=Lerkin]Дурилы вы все. Матюга на английском не смотрятся, и идею полностью не выразишь...[/QUOTE]
Ну, и другие сообщения для меня ценны. Раньше решение я принимал более интуитивно - теперь есть известные аргументы.
В опросе также нет особого смысла - просто баловство.
Стараюсь писать на английском ибо стараюсь его выучить. Но главная прична всетаки в том что розкладку менять влом.
А вообще да. Код надо писать так чтоб не надо было писать коментарии.
А вообще да. Код надо писать так чтоб не надо было писать коментарии.