|
Нужно ли документировать код C#
|
|||
---|---|---|---|
#18+
Все языки программирования имеют синтаксис документирования кода. (например javadoc, phpdocumentator,...) Причем даже стандарты документирования методов и параметров, а также классов и интерфейсов. Программист C# утверждает что код не надо документировать в C# авторпоскольку всем методам присваиваются само-описывающие имена и код понятен любому C#-разработчику Вы считаете это правильно? Или это лень? ... |
|||
:
Нравится:
Не нравится:
|
|||
12.05.2014, 10:02 |
|
Нужно ли документировать код C#
|
|||
---|---|---|---|
#18+
NrisimhaВсе языки программирования имеют синтаксис документирования кода это не свойство языка, а среды программирования ... |
|||
:
Нравится:
Не нравится:
|
|||
12.05.2014, 10:03 |
|
Нужно ли документировать код C#
|
|||
---|---|---|---|
#18+
Иногда надо, иногда не надо. ... |
|||
:
Нравится:
Не нравится:
|
|||
12.05.2014, 10:14 |
|
Нужно ли документировать код C#
|
|||
---|---|---|---|
#18+
Это лень. Даже если из названия понятно, что делает тот или иной метод, не всегда понятно как . ... |
|||
:
Нравится:
Не нравится:
|
|||
12.05.2014, 11:11 |
|
Нужно ли документировать код C#
|
|||
---|---|---|---|
#18+
Nrisimha, предлагаю тому "программисту" запретить пользоваться MSDN и любой другой документацией. Засечь, через какое время он полезет в гугл, после чего с позором уволить/отчитать/выпороть/заставить прочитать трижды всю msdn (нужное подчеркнуть). ... |
|||
:
Нравится:
Не нравится:
|
|||
12.05.2014, 11:19 |
|
Нужно ли документировать код C#
|
|||
---|---|---|---|
#18+
Для начала надо определиться, что ТС подразумевает под документированием. Потому что есть просто комментирование кода. Оно нужно хотя бы для того, чтобы быстро бегло искать взглядом нужный фрагмент, даже если названия процедур самодокументирующиеся Есть suumary для документирования библиотек для внешних вызовов А есть отдельная документация - условно говоря бумажный талмуд, в котором описана программа с разной степенью детализации (вплоть до приватных процедур) Так что, имхо, надо определиться, что именно имеет ввиду автор. ... |
|||
:
Нравится:
Не нравится:
|
|||
12.05.2014, 11:33 |
|
Нужно ли документировать код C#
|
|||
---|---|---|---|
#18+
Если программист не хочет вставлять даже мелкие комментарии по ходу текста программы, значит либо: 1) он новичок - ему кажется, что он и так помнит все свои алгоритмы (потому что он просто мало их написал в своей жизни) и нет достаточного опыта поддержки даже собственного кода 2) умышленный саботаж - ищите цели, которые он может преследовать (например привязать заказчика к себе) ... |
|||
:
Нравится:
Не нравится:
|
|||
12.05.2014, 11:45 |
|
Нужно ли документировать код C#
|
|||
---|---|---|---|
#18+
NrisimhaПрограммист C# утверждает что код не надо документировать в C#Как долго его код работает в продакшн? Сколько лет? Сколько человек за это время правило его код? ... |
|||
:
Нравится:
Не нравится:
|
|||
12.05.2014, 12:36 |
|
Нужно ли документировать код C#
|
|||
---|---|---|---|
#18+
Nrisimha Или это лень? Это пень. ... |
|||
:
Нравится:
Не нравится:
|
|||
12.05.2014, 12:45 |
|
Нужно ли документировать код C#
|
|||
---|---|---|---|
#18+
Shocker.ProДля начала надо определиться, что ТС подразумевает под документированием. Потому что есть просто комментирование кода. комментирование кода ... |
|||
:
Нравится:
Не нравится:
|
|||
12.05.2014, 15:21 |
|
Нужно ли документировать код C#
|
|||
---|---|---|---|
#18+
skyANANrisimhaПрограммист C# утверждает что код не надо документировать в C#Как долго его код работает в продакшн? Сколько лет? Сколько человек за это время правило его код? год работает в продакшен. Ни один не правил его код ... |
|||
:
Нравится:
Не нравится:
|
|||
12.05.2014, 15:22 |
|
Нужно ли документировать код C#
|
|||
---|---|---|---|
#18+
NrisimhaskyANAпропущено... Как долго его код работает в продакшн? Сколько лет? Сколько человек за это время правило его код? год работает в продакшен. Ни один не правил его код Зависит от специфики кода. Как правило в ERP системах, написанных нормально и читабельно, до 90% кода не документируется. Документировать необходимо сложные специфические математические расчеты и костыли (с какой целью был применен костыль). Так же документировать нужно ядро программы, если там используется к примеру какая-нибудь самописная ORM библиотека. Всегда должен быть компромисс между документированием и пониманием того, что написано без документации. ... |
|||
:
Нравится:
Не нравится:
|
|||
13.05.2014, 08:41 |
|
Нужно ли документировать код C#
|
|||
---|---|---|---|
#18+
NrisimhaskyANAпропущено... Как долго его код работает в продакшн? Сколько лет? Сколько человек за это время правило его код? год работает в продакшен. Ни один не правил его код это п....ц, как только но свалит, вы хлебнёте по-полной ... |
|||
:
Нравится:
Не нравится:
|
|||
14.05.2014, 19:40 |
|
Нужно ли документировать код C#
|
|||
---|---|---|---|
#18+
имхо, промышленный код обязан быть документирован, не зависимо от интуитивной понятности метода. если это какое то эссе или коломбур в общении то по соглашению сторон. так же имхо, документировать надо разные плюшки, ( изменение состояния объекта (sender) через события) трудно уловимые для понимания.. и т.д. а методы интерфейса исключительно всегда, как бы в недавнем прошлом получил урок от буржуев.. ... |
|||
:
Нравится:
Не нравится:
|
|||
14.05.2014, 20:01 |
|
Нужно ли документировать код C#
|
|||
---|---|---|---|
#18+
pationNrisimhaпропущено... год работает в продакшен. Ни один не правил его код это п....ц, как только но свалит, вы хлебнёте по-полнойКак будто комментарии чем-то помогут. ... |
|||
:
Нравится:
Не нравится:
|
|||
15.05.2014, 07:15 |
|
Нужно ли документировать код C#
|
|||
---|---|---|---|
#18+
Где-то в степиимхо, промышленный код обязан быть документирован, не зависимо от интуитивной понятности метода.Деньги девать некуда? Где-то в степитрудно уловимые для понимания.. и т.д.Это да. С другой стороны, это время лучше потратить на улучшение программы, чтобы она стала "легко уловимой". Где-то в степиа методы интерфейса исключительно всегда, как бы в недавнем прошлом получил урок от буржуев..В последнее время качество "буржуйского" кода вызывает удивление. Я бы не стал брать у них уроки. ... |
|||
:
Нравится:
Не нравится:
|
|||
15.05.2014, 07:18 |
|
Нужно ли документировать код C#
|
|||
---|---|---|---|
#18+
Алексей КДеньги девать некуда? Зависит от. Если продукт продается с апи той или иной степени открытости, то документирование этого апи - составная часть процесса производста продукта. ... |
|||
:
Нравится:
Не нравится:
|
|||
15.05.2014, 09:00 |
|
Нужно ли документировать код C#
|
|||
---|---|---|---|
#18+
Сон Веры ПавловныАлексей КДеньги девать некуда? Зависит от. Если продукт продается с апи той или иной степени открытости, то документирование этого апи - составная часть процесса производста продукта.Документирование этого API, скорее всего, производится ещё до написания программы. ... |
|||
:
Нравится:
Не нравится:
|
|||
15.05.2014, 09:18 |
|
Нужно ли документировать код C#
|
|||
---|---|---|---|
#18+
Алексей Кpationпропущено... это п....ц, как только но свалит, вы хлебнёте по-полнойКак будто комментарии чем-то помогут.Смотря как их писать ... |
|||
:
Нравится:
Не нравится:
|
|||
15.05.2014, 10:21 |
|
Нужно ли документировать код C#
|
|||
---|---|---|---|
#18+
Алексей К, авторВ последнее время качество "буржуйского" кода вызывает удивление. Я бы не стал брать у них уроки. - Так я и думал (с) [spoiler] ... |
|||
:
Нравится:
Не нравится:
|
|||
15.05.2014, 10:48 |
|
Нужно ли документировать код C#
|
|||
---|---|---|---|
#18+
http://www.gazeta.ru/business/news/2014/04/30/n_6119681.shtml Русские программисты, давайте ответим на санкции ( тынц выше) Не будем писать комментарии к коду, а так же любые тесты, давать только русские имена переменным и процедурам. единственно что настораживает, если будет запрет на поставку унитазов из Италии, то естественно симметричны ответом будет - в каждый двор по комплексу уборных с дыркой в полу.. ... |
|||
:
Нравится:
Не нравится:
|
|||
15.05.2014, 11:05 |
|
Нужно ли документировать код C#
|
|||
---|---|---|---|
#18+
Где-то в степив свете последних решений партии, брать у них ничего не стоит..."Ладно-ладно! Нам бы только иностранное ругать..." (из к/ф "О бедном гусаре замолвите слово") ... |
|||
:
Нравится:
Не нравится:
|
|||
15.05.2014, 12:06 |
|
Нужно ли документировать код C#
|
|||
---|---|---|---|
#18+
Где-то в степи http://www.gazeta.ru/business/news/2014/04/30/n_6119681.shtml Русские программисты, давайте ответим на санкции ( тынц выше)Если SAP присоединится к санкциям, это будет такой для нас подарок. Где-то в степиНе будем писать комментарии к коду, а так же любые тесты, давать только русские имена переменным и процедурам.Всегда "чисто русские" идентификаторы обзывали в транслите, назло врагам... :-) Где-то в степиединственно что настораживает, если будет запрет на поставку унитазов из Италии, то естественно симметричны ответом будет - в каждый двор по комплексу уборных с дыркой в полу..Потерпим... ... |
|||
:
Нравится:
Не нравится:
|
|||
15.05.2014, 12:13 |
|
Нужно ли документировать код C#
|
|||
---|---|---|---|
#18+
Алексей КВсегда "чисто русские" идентификаторы обзывали в транслите, назло врагам... :-) Мне страшно на это даже взглянуть)) ... |
|||
:
Нравится:
Не нравится:
|
|||
15.05.2014, 13:45 |
|
Нужно ли документировать код C#
|
|||
---|---|---|---|
#18+
Как правило, бухгалтерские термины, которым трудно найти однозначную и понятную замену в английском, ибо специфика учета. ... |
|||
:
Нравится:
Не нравится:
|
|||
15.05.2014, 14:00 |
|
Нужно ли документировать код C#
|
|||
---|---|---|---|
#18+
Алексей Кпоследнее время качество "буржуйского" кода вызывает удивление. Я бы не стал брать у них уроки. Да, у нас беда тут. Все покрыто аджайлом и ТДД. не зависимо от необходимости.... ... |
|||
:
Нравится:
Не нравится:
|
|||
21.05.2014, 15:29 |
|
Нужно ли документировать код C#
|
|||
---|---|---|---|
#18+
В последнее время т.н. самодокументированный (self documenting в общем) код набирает популярность. По крайней мере, все больше о нем говорить стали. Иногда, это, к сожалению используется как повод не писать комментарии к коду. Код , где мало комментариев требует более аккуратного анализа и большего времени его исправления. Передача такого кода другим сотрудникам явно проигрывать, чем передача хорошо документированного кода. ... |
|||
:
Нравится:
Не нравится:
|
|||
21.05.2014, 15:34 |
|
Нужно ли документировать код C#
|
|||
---|---|---|---|
#18+
по моему опыту код меняется, а комментарии к нему нет, потому становится еще хуже. Так что для не публичного апи пишу комментарии только там где лень писать хороший код или это сделать неоправданно трудно. Ну и неочевидности типа там overrride {//prevent}. TODO еще. ну еще рода //performance critical или //for unknown reason if we omit this line event is not fired in lib telerik... ... |
|||
:
Нравится:
Не нравится:
|
|||
21.05.2014, 16:13 |
|
Нужно ли документировать код C#
|
|||
---|---|---|---|
#18+
FactorizeВ последнее время т.н. самодокументированный (self documenting в общем) код набирает популярность. По крайней мере, все больше о нем говорить стали.Тренды в последнее время меняются слишком часто, чтобы относиться к ним серьёзно. Единственный выход из положения, это иметь своё мнение и не доверять никому. Более того, иногда мне кажется, что некоторые материалы публикуются специально с целью навредить читателю. ... |
|||
:
Нравится:
Не нравится:
|
|||
21.05.2014, 16:17 |
|
Нужно ли документировать код C#
|
|||
---|---|---|---|
#18+
NrisimhaВсе языки программирования имеют синтаксис документирования кода. (например javadoc, phpdocumentator,...) Причем даже стандарты документирования методов и параметров, а также классов и интерфейсов. Программист C# утверждает что код не надо документировать в C# авторпоскольку всем методам присваиваются само-описывающие имена и код понятен любому C#-разработчику Вы считаете это правильно? Или это лень? Это зависит от того, был ли задокументирован код до тебя. Если нет и тебе пришлось самому во всём разбираться - с куя ли ты должен им подслащать жизнь? Оставь им тоже код в наследство без комментариев и с не понятными названиями переменных. Пусть их путь тоже будет тернист и долог (демонический смех). ... |
|||
:
Нравится:
Не нравится:
|
|||
22.05.2014, 09:41 |
|
Нужно ли документировать код C#
|
|||
---|---|---|---|
#18+
Написав сейчас большой фрагмент библиотеки на JavaScript обнаружил, что мой код прямо-таки пестрит комментариями, несмотря на то, что старался не говнокодить, "по уму" - все выведено в методы/свойсва объектов, все строго структурировано по функциональности и разбито по файлам В то же время аналогичный объем кода того же автора на C# содержит примерно в четыре раза меньше комментариев. Так что качество ЯП тоже в значительной мере накладывает свой отпечаток. ... |
|||
:
Нравится:
Не нравится:
|
|||
22.06.2014, 12:39 |
|
Нужно ли документировать код C#
|
|||
---|---|---|---|
#18+
Shocker.Pro, авторНаписав сейчас большой фрагмент библиотеки на JavaScript приведите его к -min.js, не такой уж он и большой :)) ... |
|||
:
Нравится:
Не нравится:
|
|||
22.06.2014, 12:55 |
|
Нужно ли документировать код C#
|
|||
---|---|---|---|
#18+
если придираться, то переформулирую - достаточно большой, чтобы оценить процент комментариев разве мы не "на ты"? ... |
|||
:
Нравится:
Не нравится:
|
|||
22.06.2014, 13:04 |
|
Нужно ли документировать код C#
|
|||
---|---|---|---|
#18+
Shocker.Pro, Расскажи, что библиотека делает ? Вообще то, как бы тут сравнивать с # Документировать надо что наружу торчит и интерфейсы внутренности конечно по соображению где проходят ключевые моменты. можно так задокументировать, что и написать войну и мир на основе hello world :)) ( так сказать компилятор все стерпит) ... |
|||
:
Нравится:
Не нравится:
|
|||
22.06.2014, 13:14 |
|
Нужно ли документировать код C#
|
|||
---|---|---|---|
#18+
Вот у меня пере домной лежит библия от Страуструппа. грамм 400 будет, если ее рассматривать как код, кода там не много, но комментариев наворотил - мама не горюй )) ... |
|||
:
Нравится:
Не нравится:
|
|||
22.06.2014, 13:19 |
|
Нужно ли документировать код C#
|
|||
---|---|---|---|
#18+
Долго рассказывать, и мы уйдем в сторону. Суть в другом. Каждый раз записывая комментарий, я понимал, что если бы у меня в браузере был C# вместо JS, мне бы этот комментарий не понадобился, потому что либо был бы строгий тип, либо это было бы реализовано немножко иначе и самоочевиднее, либо эту заплатку вообще не пришлось бы делать. Достаточно было бы просто прокомментировать сами методы, не особо комментируя алгоритмы, так как там все довольно примитивно. ... |
|||
:
Нравится:
Не нравится:
|
|||
22.06.2014, 13:28 |
|
Нужно ли документировать код C#
|
|||
---|---|---|---|
#18+
Где-то в степиВот у меня пере домной лежит библия от Страуструппа. грамм 400 будет, если ее рассматривать как код, кода там не много, но комментариев наворотил - мама не горюй )) странно, моя грамм 600 весит ... |
|||
:
Нравится:
Не нравится:
|
|||
22.06.2014, 14:55 |
|
Нужно ли документировать код C#
|
|||
---|---|---|---|
#18+
Изопропилстранно, моя грамм 600 веситруки плохо мыл, зачитал ... |
|||
:
Нравится:
Не нравится:
|
|||
22.06.2014, 15:10 |
|
Нужно ли документировать код C#
|
|||
---|---|---|---|
#18+
ИзопропилГде-то в степиВот у меня пере домной лежит библия от Страуструппа. грамм 400 будет, если ее рассматривать как код, кода там не много, но комментариев наворотил - мама не горюй )) странно, моя грамм 600 весит прикинул на напольных, ~ кило сто , оболдетьюю.. ей и убить можно если чо.. ... |
|||
:
Нравится:
Не нравится:
|
|||
22.06.2014, 19:08 |
|
|
start [/forum/topic.php?all=1&fid=20&tid=1402785]: |
0ms |
get settings: |
9ms |
get forum list: |
12ms |
check forum access: |
3ms |
check topic access: |
3ms |
track hit: |
36ms |
get topic data: |
10ms |
get forum data: |
3ms |
get page messages: |
66ms |
get tp. blocked users: |
2ms |
others: | 356ms |
total: | 500ms |
0 / 0 |