|
Нужно ли документировать код 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/search_topic.php?author=mugil&author_mode=last_topics&do_search=1]: |
0ms |
get settings: |
10ms |
get forum list: |
14ms |
get settings: |
9ms |
get forum list: |
13ms |
check forum access: |
4ms |
check topic access: |
4ms |
track hit: |
34ms |
get topic data: |
8ms |
get forum data: |
2ms |
get page messages: |
50ms |
get tp. blocked users: |
1ms |
others: | 490ms |
total: | 639ms |
0 / 0 |