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

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

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

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

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

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

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

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


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

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

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

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

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

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

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

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

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

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


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

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

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


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

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


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

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

Где-то в степиединственно что настораживает, если будет запрет на поставку унитазов из Италии, то естественно симметричны ответом будет
- в каждый двор по комплексу уборных с дыркой в полу..Потерпим...
...
Рейтинг: 0 / 0
15.05.2014, 12:13
| Ответить | Цитировать | Написать  
Нужно ли документировать код C#
    #38642198
dma_caviar
Скрыть профиль Поместить в игнор-лист Сообщения автора в теме
dma_caviar
Участник
Алексей КВсегда "чисто русские" идентификаторы обзывали в транслите, назло врагам... :-)
Мне страшно на это даже взглянуть))
...
Рейтинг: 0 / 0
15.05.2014, 13:45
| Ответить | Цитировать | Написать  
Нужно ли документировать код C#
    #38642220
Фотография Shocker.Pro
Скрыть профиль Поместить в игнор-лист Сообщения автора в теме
Shocker.Pro
Участник
Как правило, бухгалтерские термины, которым трудно найти однозначную и понятную замену в английском, ибо специфика учета.
...
Рейтинг: 0 / 0
15.05.2014, 14:00
| Ответить | Цитировать | Написать  
25 сообщений из 40, страница 1 из 2
  1  все
Форумы / WinForms, .Net Framework [игнор отключен] [закрыт для гостей] / Нужно ли документировать код C#
Найденые пользователи ...
Разблокировать пользователей ...
Читали тему (0):
Читали форум (0):
Пользователи онлайн (0):
Польз. соглашение
NoSQL.ru       Новости, Чат       Фотоальбом: Участники, Встречи
Закрыть
start [/forum/topic.php?fid=20&msg=38638869&tid=1402785]:
 0ms
get settings:
 9ms
get forum list:
 12ms
check forum access:
 3ms
check topic access:
 3ms
track hit:
 58ms
get topic data:
 9ms
get forum data:
 2ms
get page messages:
 56ms
get tp. blocked users:
 2ms
others: 328ms
total:  482ms
созд. / загр.: 482ms
x
x
Закрыть


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