powered by simpleCommunicator - 2.0.55     © 2025 Programmizd 02
Целевая тема:
Создать новую тему:
Автор:
Закрыть
Цитировать
Форумы / WinForms, .Net Framework [игнор отключен] [закрыт для гостей] / Нужно ли документировать код C#
40 сообщений из 40, показаны все 2 страниц
Нужно ли документировать код C#
    #38638359
Фотография Nrisimha
Скрыть профиль Поместить в игнор-лист Сообщения автора в теме
Участник
Все языки программирования имеют синтаксис документирования кода. (например javadoc, phpdocumentator,...) Причем даже стандарты документирования методов и параметров, а также классов и интерфейсов.

Программист C# утверждает что код не надо документировать в C#

авторпоскольку всем методам присваиваются само-описывающие имена и код понятен любому C#-разработчику

Вы считаете это правильно? Или это лень?
...
Рейтинг: 0 / 0
Нужно ли документировать код C#
    #38638362
Фотография Изопропил
Скрыть профиль Поместить в игнор-лист Сообщения автора в теме
Участник
NrisimhaВсе языки программирования имеют синтаксис документирования кода
это не свойство языка, а среды программирования
...
Рейтинг: 0 / 0
Нужно ли документировать код C#
    #38638379
Pallaris
Скрыть профиль Поместить в игнор-лист Сообщения автора в теме
Участник
Иногда надо, иногда не надо.
...
Рейтинг: 0 / 0
Нужно ли документировать код C#
    #38638467
Фотография Antonariy
Скрыть профиль Поместить в игнор-лист Сообщения автора в теме
Участник
Это лень. Даже если из названия понятно, что делает тот или иной метод, не всегда понятно как .
...
Рейтинг: 0 / 0
Нужно ли документировать код C#
    #38638480
petalvik
Скрыть профиль Поместить в игнор-лист Сообщения автора в теме
Участник
Nrisimha,

предлагаю тому "программисту" запретить пользоваться MSDN и любой другой документацией. Засечь, через какое время он полезет в гугл, после чего с позором уволить/отчитать/выпороть/заставить прочитать трижды всю msdn (нужное подчеркнуть).
...
Рейтинг: 0 / 0
Нужно ли документировать код C#
    #38638501
Фотография Shocker.Pro
Скрыть профиль Поместить в игнор-лист Сообщения автора в теме
Участник
Для начала надо определиться, что ТС подразумевает под документированием.

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

Есть suumary для документирования библиотек для внешних вызовов

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


Так что, имхо, надо определиться, что именно имеет ввиду автор.
...
Рейтинг: 0 / 0
Нужно ли документировать код C#
    #38638525
Фотография Shocker.Pro
Скрыть профиль Поместить в игнор-лист Сообщения автора в теме
Участник
Если программист не хочет вставлять даже мелкие комментарии по ходу текста программы, значит либо:

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

2) умышленный саботаж - ищите цели, которые он может преследовать (например привязать заказчика к себе)
...
Рейтинг: 0 / 0
Нужно ли документировать код C#
    #38638597
Фотография skyANA
Скрыть профиль Поместить в игнор-лист Сообщения автора в теме
Участник
NrisimhaПрограммист C# утверждает что код не надо документировать в C#Как долго его код работает в продакшн? Сколько лет? Сколько человек за это время правило его код?
...
Рейтинг: 0 / 0
Нужно ли документировать код C#
    #38638608
Monochromatique
Скрыть профиль Поместить в игнор-лист Сообщения автора в теме
Участник
Nrisimha Или это лень?

Это пень.
...
Рейтинг: 0 / 0
Нужно ли документировать код C#
    #38638867
Фотография Nrisimha
Скрыть профиль Поместить в игнор-лист Сообщения автора в теме
Участник
Shocker.ProДля начала надо определиться, что ТС подразумевает под документированием.

Потому что есть просто комментирование кода.

комментирование кода
...
Рейтинг: 0 / 0
Нужно ли документировать код C#
    #38638869
Фотография Nrisimha
Скрыть профиль Поместить в игнор-лист Сообщения автора в теме
Участник
skyANANrisimhaПрограммист C# утверждает что код не надо документировать в C#Как долго его код работает в продакшн? Сколько лет? Сколько человек за это время правило его код?

год работает в продакшен. Ни один не правил его код
...
Рейтинг: 0 / 0
Нужно ли документировать код C#
    #38639371
LameUser
Скрыть профиль Поместить в игнор-лист Сообщения автора в теме
Участник
NrisimhaskyANAпропущено...
Как долго его код работает в продакшн? Сколько лет? Сколько человек за это время правило его код?

год работает в продакшен. Ни один не правил его код

Зависит от специфики кода.
Как правило в ERP системах, написанных нормально и читабельно, до 90% кода не документируется.

Документировать необходимо сложные специфические математические расчеты и костыли (с какой целью был применен костыль).
Так же документировать нужно ядро программы, если там используется к примеру какая-нибудь самописная ORM библиотека.


Всегда должен быть компромисс между документированием и пониманием того, что написано без документации.
...
Рейтинг: 0 / 0
Нужно ли документировать код C#
    #38641480
Фотография pation
Скрыть профиль Поместить в игнор-лист Сообщения автора в теме
Участник
NrisimhaskyANAпропущено...
Как долго его код работает в продакшн? Сколько лет? Сколько человек за это время правило его код?

год работает в продакшен. Ни один не правил его код

это п....ц, как только но свалит, вы хлебнёте по-полной
...
Рейтинг: 0 / 0
Нужно ли документировать код C#
    #38641493
Фотография Где-то в степи
Скрыть профиль Поместить в игнор-лист Сообщения автора в теме
Участник
имхо, промышленный код обязан быть документирован, не зависимо от интуитивной понятности метода.
если это какое то эссе или коломбур в общении то по соглашению сторон.
так же имхо, документировать надо разные плюшки, ( изменение состояния объекта (sender) через события)
трудно уловимые для понимания.. и т.д.
а методы интерфейса исключительно всегда, как бы в недавнем прошлом получил урок от буржуев..
...
Рейтинг: 0 / 0
Нужно ли документировать код C#
    #38641700
Фотография Алексей К
Скрыть профиль Поместить в игнор-лист Сообщения автора в теме
Участник
pationNrisimhaпропущено...


год работает в продакшен. Ни один не правил его код

это п....ц, как только но свалит, вы хлебнёте по-полнойКак будто комментарии чем-то помогут.
...
Рейтинг: 0 / 0
Нужно ли документировать код C#
    #38641703
Фотография Алексей К
Скрыть профиль Поместить в игнор-лист Сообщения автора в теме
Участник
Где-то в степиимхо, промышленный код обязан быть документирован, не зависимо от интуитивной понятности метода.Деньги девать некуда?
Где-то в степитрудно уловимые для понимания.. и т.д.Это да. С другой стороны, это время лучше потратить на улучшение программы, чтобы она стала "легко уловимой".
Где-то в степиа методы интерфейса исключительно всегда, как бы в недавнем прошлом получил урок от буржуев..В последнее время качество "буржуйского" кода вызывает удивление. Я бы не стал брать у них уроки.
...
Рейтинг: 0 / 0
Нужно ли документировать код C#
    #38641753
Сон Веры Павловны
Скрыть профиль Поместить в игнор-лист Сообщения автора в теме
Участник
Алексей КДеньги девать некуда?
Зависит от. Если продукт продается с апи той или иной степени открытости, то документирование этого апи - составная часть процесса производста продукта.
...
Рейтинг: 0 / 0
Нужно ли документировать код C#
    #38641762
Фотография Алексей К
Скрыть профиль Поместить в игнор-лист Сообщения автора в теме
Участник
Сон Веры ПавловныАлексей КДеньги девать некуда?
Зависит от. Если продукт продается с апи той или иной степени открытости, то документирование этого апи - составная часть процесса производста продукта.Документирование этого API, скорее всего, производится ещё до написания программы.
...
Рейтинг: 0 / 0
Нужно ли документировать код C#
    #38641838
Фотография skyANA
Скрыть профиль Поместить в игнор-лист Сообщения автора в теме
Участник
Алексей Кpationпропущено...


это п....ц, как только но свалит, вы хлебнёте по-полнойКак будто комментарии чем-то помогут.Смотря как их писать
...
Рейтинг: 0 / 0
Нужно ли документировать код C#
    #38641895
Фотография Где-то в степи
Скрыть профиль Поместить в игнор-лист Сообщения автора в теме
Участник
Алексей К,
авторВ последнее время качество "буржуйского" кода вызывает удивление. Я бы не стал брать у них уроки.
- Так я и думал (с)
[spoiler]
YouTube Video
...
Рейтинг: 0 / 0
Нужно ли документировать код C#
    #38641926
Фотография Где-то в степи
Скрыть профиль Поместить в игнор-лист Сообщения автора в теме
Участник
http://www.gazeta.ru/business/news/2014/04/30/n_6119681.shtml
Русские программисты, давайте ответим на санкции ( тынц выше)
Не будем писать комментарии к коду, а так же любые тесты, давать только русские имена переменным и процедурам.
единственно что настораживает, если будет запрет на поставку унитазов из Италии, то естественно симметричны ответом будет
- в каждый двор по комплексу уборных с дыркой в полу..
...
Рейтинг: 0 / 0
Нужно ли документировать код C#
    #38642038
Фотография Алексей К
Скрыть профиль Поместить в игнор-лист Сообщения автора в теме
Участник
Где-то в степив свете последних решений партии, брать у них ничего не стоит..."Ладно-ладно! Нам бы только иностранное ругать..." (из к/ф "О бедном гусаре замолвите слово")
...
Рейтинг: 0 / 0
Нужно ли документировать код C#
    #38642051
Фотография Алексей К
Скрыть профиль Поместить в игнор-лист Сообщения автора в теме
Участник
Где-то в степи http://www.gazeta.ru/business/news/2014/04/30/n_6119681.shtml
Русские программисты, давайте ответим на санкции ( тынц выше)Если SAP присоединится к санкциям, это будет такой для нас подарок.

Где-то в степиНе будем писать комментарии к коду, а так же любые тесты, давать только русские имена переменным и процедурам.Всегда "чисто русские" идентификаторы обзывали в транслите, назло врагам... :-)

Где-то в степиединственно что настораживает, если будет запрет на поставку унитазов из Италии, то естественно симметричны ответом будет
- в каждый двор по комплексу уборных с дыркой в полу..Потерпим...
...
Рейтинг: 0 / 0
Нужно ли документировать код C#
    #38642198
dma_caviar
Скрыть профиль Поместить в игнор-лист Сообщения автора в теме
Участник
Алексей КВсегда "чисто русские" идентификаторы обзывали в транслите, назло врагам... :-)
Мне страшно на это даже взглянуть))
...
Рейтинг: 0 / 0
Нужно ли документировать код C#
    #38642220
Фотография Shocker.Pro
Скрыть профиль Поместить в игнор-лист Сообщения автора в теме
Участник
Как правило, бухгалтерские термины, которым трудно найти однозначную и понятную замену в английском, ибо специфика учета.
...
Рейтинг: 0 / 0
Нужно ли документировать код C#
    #38647697
Фотография D129
Скрыть профиль Поместить в игнор-лист Сообщения автора в теме
Участник
Алексей Кпоследнее время качество "буржуйского" кода вызывает удивление. Я бы не стал брать у них уроки.

Да, у нас беда тут. Все покрыто аджайлом и ТДД. не зависимо от необходимости....
...
Рейтинг: 0 / 0
Нужно ли документировать код C#
    #38647707
Factorize
Скрыть профиль Поместить в игнор-лист Сообщения автора в теме
Участник
В последнее время т.н. самодокументированный (self documenting в общем) код набирает популярность. По крайней мере, все больше о нем говорить стали. Иногда, это, к сожалению используется как повод не писать комментарии к коду.
Код , где мало комментариев требует более аккуратного анализа и большего времени его исправления. Передача такого кода другим сотрудникам явно проигрывать, чем передача хорошо документированного кода.
...
Рейтинг: 0 / 0
Нужно ли документировать код C#
    #38647792
Фотография Denis.
Скрыть профиль Поместить в игнор-лист Сообщения автора в теме
Участник
по моему опыту код меняется, а комментарии к нему нет, потому становится еще хуже. Так что для не публичного апи пишу комментарии только там где лень писать хороший код или это сделать неоправданно трудно.
Ну и неочевидности типа там overrride {//prevent}. TODO еще. ну еще рода //performance critical или //for unknown reason if we omit this line event is not fired in lib telerik...
...
Рейтинг: 0 / 0
Нужно ли документировать код C#
    #38647800
Фотография Алексей К
Скрыть профиль Поместить в игнор-лист Сообщения автора в теме
Участник
FactorizeВ последнее время т.н. самодокументированный (self documenting в общем) код набирает популярность. По крайней мере, все больше о нем говорить стали.Тренды в последнее время меняются слишком часто, чтобы относиться к ним серьёзно. Единственный выход из положения, это иметь своё мнение и не доверять никому.
Может дело в этом?

Более того, иногда мне кажется, что некоторые материалы публикуются специально с целью навредить читателю.
...
Рейтинг: 0 / 0
Нужно ли документировать код C#
    #38648400
user7320
Скрыть профиль Поместить в игнор-лист Сообщения автора в теме
Участник
NrisimhaВсе языки программирования имеют синтаксис документирования кода. (например javadoc, phpdocumentator,...) Причем даже стандарты документирования методов и параметров, а также классов и интерфейсов.

Программист C# утверждает что код не надо документировать в C#

авторпоскольку всем методам присваиваются само-описывающие имена и код понятен любому C#-разработчику

Вы считаете это правильно? Или это лень?
Это зависит от того, был ли задокументирован код до тебя. Если нет и тебе пришлось самому во всём разбираться - с куя ли ты должен им подслащать жизнь? Оставь им тоже код в наследство без комментариев и с не понятными названиями переменных. Пусть их путь тоже будет тернист и долог (демонический смех).
...
Рейтинг: 0 / 0
Нужно ли документировать код C#
    #38676520
Фотография Shocker.Pro
Скрыть профиль Поместить в игнор-лист Сообщения автора в теме
Участник
Написав сейчас большой фрагмент библиотеки на JavaScript обнаружил, что мой код прямо-таки пестрит комментариями, несмотря на то, что старался не говнокодить, "по уму" - все выведено в методы/свойсва объектов, все строго структурировано по функциональности и разбито по файлам
В то же время аналогичный объем кода того же автора на C# содержит примерно в четыре раза меньше комментариев. Так что качество ЯП тоже в значительной мере накладывает свой отпечаток.
...
Рейтинг: 0 / 0
Нужно ли документировать код C#
    #38676523
Фотография Где-то в степи
Скрыть профиль Поместить в игнор-лист Сообщения автора в теме
Участник
Shocker.Pro,
авторНаписав сейчас большой фрагмент библиотеки на JavaScript
приведите его к -min.js, не такой уж он и большой :))
...
Рейтинг: 0 / 0
Нужно ли документировать код C#
    #38676530
Фотография Shocker.Pro
Скрыть профиль Поместить в игнор-лист Сообщения автора в теме
Участник
если придираться, то переформулирую - достаточно большой, чтобы оценить процент комментариев

разве мы не "на ты"?
...
Рейтинг: 0 / 0
Нужно ли документировать код C#
    #38676535
Фотография Где-то в степи
Скрыть профиль Поместить в игнор-лист Сообщения автора в теме
Участник
Shocker.Pro,
Расскажи, что библиотека делает ?
Вообще то, как бы тут сравнивать с #
Документировать надо что наружу торчит и интерфейсы
внутренности конечно по соображению где проходят ключевые моменты.
можно так задокументировать, что и написать войну и мир на основе hello world :))
( так сказать компилятор все стерпит)
...
Рейтинг: 0 / 0
Нужно ли документировать код C#
    #38676539
Фотография Где-то в степи
Скрыть профиль Поместить в игнор-лист Сообщения автора в теме
Участник
Вот у меня пере домной лежит библия от Страуструппа.
грамм 400 будет, если ее рассматривать как код, кода там не много, но комментариев наворотил - мама не горюй ))
...
Рейтинг: 0 / 0
Нужно ли документировать код C#
    #38676542
Фотография Shocker.Pro
Скрыть профиль Поместить в игнор-лист Сообщения автора в теме
Участник
Долго рассказывать, и мы уйдем в сторону. Суть в другом.
Каждый раз записывая комментарий, я понимал, что если бы у меня в браузере был C# вместо JS, мне бы этот комментарий не понадобился, потому что либо был бы строгий тип, либо это было бы реализовано немножко иначе и самоочевиднее, либо эту заплатку вообще не пришлось бы делать. Достаточно было бы просто прокомментировать сами методы, не особо комментируя алгоритмы, так как там все довольно примитивно.
...
Рейтинг: 0 / 0
Нужно ли документировать код C#
    #38676592
Фотография Изопропил
Скрыть профиль Поместить в игнор-лист Сообщения автора в теме
Участник
Где-то в степиВот у меня пере домной лежит библия от Страуструппа.
грамм 400 будет, если ее рассматривать как код, кода там не много, но комментариев наворотил - мама не горюй ))
странно, моя грамм 600 весит
...
Рейтинг: 0 / 0
Нужно ли документировать код C#
    #38676596
Фотография Shocker.Pro
Скрыть профиль Поместить в игнор-лист Сообщения автора в теме
Участник
Изопропилстранно, моя грамм 600 веситруки плохо мыл, зачитал
...
Рейтинг: 0 / 0
Нужно ли документировать код C#
    #38676667
Фотография Где-то в степи
Скрыть профиль Поместить в игнор-лист Сообщения автора в теме
Участник
ИзопропилГде-то в степиВот у меня пере домной лежит библия от Страуструппа.
грамм 400 будет, если ее рассматривать как код, кода там не много, но комментариев наворотил - мама не горюй ))
странно, моя грамм 600 весит
прикинул на напольных, ~ кило сто , оболдетьюю..
ей и убить можно если чо..
...
Рейтинг: 0 / 0
Нужно ли документировать код C#
    #38676763
Фотография Zukora
Скрыть профиль Поместить в игнор-лист Сообщения автора в теме
Участник
Где-то в степи,
Ща бумага не та. Я когда то реально двухтомником Фихтенгольца по матану оборону держал.
...
Рейтинг: 0 / 0
40 сообщений из 40, показаны все 2 страниц
Форумы / WinForms, .Net Framework [игнор отключен] [закрыт для гостей] / Нужно ли документировать код C#
Найденые пользователи ...
Разблокировать пользователей ...
Читали форум (0):
Пользователи онлайн (0):
x
x
Закрыть


Просмотр
0 / 0
Close
Debug Console [Select Text]