powered by simpleCommunicator - 2.0.55     © 2025 Programmizd 02
Целевая тема:
Создать новую тему:
Автор:
Закрыть
Цитировать
Форумы / WinForms, .Net Framework [игнор отключен] [закрыт для гостей] / Нужно ли документировать код C#
15 сообщений из 40, страница 2 из 2
Нужно ли документировать код 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
15 сообщений из 40, страница 2 из 2
Форумы / WinForms, .Net Framework [игнор отключен] [закрыт для гостей] / Нужно ли документировать код C#
Найденые пользователи ...
Разблокировать пользователей ...
Читали форум (0):
Пользователи онлайн (0):
x
x
Закрыть


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