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

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

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

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

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

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

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

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


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

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

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

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

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

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

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

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

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

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


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

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

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


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

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


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

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

Где-то в степиединственно что настораживает, если будет запрет на поставку унитазов из Италии, то естественно симметричны ответом будет
- в каждый двор по комплексу уборных с дыркой в полу..Потерпим...
...
Рейтинг: 0 / 0
15.05.2014, 13:45
    #38642198
dma_caviar
Участник
Скрыть профиль Поместить в игнор-лист Сообщения автора в теме
Нужно ли документировать код C#
Алексей КВсегда "чисто русские" идентификаторы обзывали в транслите, назло врагам... :-)
Мне страшно на это даже взглянуть))
...
Рейтинг: 0 / 0
15.05.2014, 14:00
    #38642220
Shocker.Pro
Участник
Скрыть профиль Поместить в игнор-лист Сообщения автора в теме
Нужно ли документировать код C#
Как правило, бухгалтерские термины, которым трудно найти однозначную и понятную замену в английском, ибо специфика учета.
...
Рейтинг: 0 / 0
Форумы / WinForms, .Net Framework [игнор отключен] [закрыт для гостей] / Нужно ли документировать код C# / 25 сообщений из 40, страница 1 из 2
Найденые пользователи ...
Разблокировать пользователей ...
Читали форум (0):
Пользователи онлайн (0):
x
x
Закрыть


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