|
Заголовочные файлы и С#
|
|||
---|---|---|---|
#18+
Petro123skyANAпропущено... Покликай правой кнопкой мыши и посмотри комбинации клавиш. Алексей К, тебе ответил. Обозреватель структуры WPF появился в 2015upd3. Почти тоже самое но не то есть в WinForms. Даже в ворде Это есть ))))) ? ... |
|||
:
Нравится:
Не нравится:
|
|||
02.10.2017, 11:30 |
|
Заголовочные файлы и С#
|
|||
---|---|---|---|
#18+
skyANA? Word меню, 5 режимов просмотра документа. Аналогия понятна? У нас только один. ... |
|||
:
Нравится:
Не нравится:
|
|||
02.10.2017, 11:47 |
|
Заголовочные файлы и С#
|
|||
---|---|---|---|
#18+
skyANAАлексей К, вот как понятнее, так: Код: c# 1. 2. 3.
или так: Код: c# 1. 2. 3. 4. 5. 6. 7. 8. 9. 10. 11. 12. 13. 14. 15. 16. 17. 18. 19. 20. 21. 22. 23.
? Встает вопрос. Если вы не можете написать краткий, но исчерпывающий комментарий о том, что делает код, а не как написан, в состоянии ли вы написать сам такой код? Понимаете ли вы, зачем он нужен, логику создания данного класса, его методов и свойств? А так в комментарий еще можно написать свои размышления на эту тему, где и зачем его использовали, ну и пару анекдотов, чтоб не скучно было )) ... |
|||
:
Нравится:
Не нравится:
|
|||
02.10.2017, 12:02 |
|
Заголовочные файлы и С#
|
|||
---|---|---|---|
#18+
Petro123Вы с позиции начальства говорите), а я с позиции программиста). Код в коде должен быть понятен программисту, а не вам)). Есть вилка максималистов. На соседней ветке чел весь код увешал комметами. И есть те, кто вообще не ставит. Я посередине) Разумная достаточность. (С) Про обозреваемость кода: - кто при открытии кода лезет не в файл, а в обозреватель классов? - почему ide не группирует вместе public/private? - почему по умолчанию новый метод она ставит internal? группа "Звери" ... |
|||
:
Нравится:
Не нравится:
|
|||
02.10.2017, 13:10 |
|
Заголовочные файлы и С#
|
|||
---|---|---|---|
#18+
hVosttПотом при сборке генерится документация и выкладываеся в вики автоматом Чем генерируете? Я пробовал SandCastle, но его выходной формат мне не понравился. Разбираться с настройкой своего формата не захотелось. Petro123У меня методы размер с экран и треть отдать под описание что я делал? А что, сворачивание не работает? ... |
|||
:
Нравится:
Не нравится:
|
|||
02.10.2017, 13:54 |
|
Заголовочные файлы и С#
|
|||
---|---|---|---|
#18+
Arm79, Работает, но хочется большего. Целиком на документ Свернуть грёбаные комменты и показать только при клике мышкой. Я 95 проц.времени код пишу, а не комменты читаю. При свёрт и развёрт они вместе с кодом мешаются. А в своём коде мне 1 строки достаточно. Память не дырявая. ... |
|||
:
Нравится:
Не нравится:
|
|||
02.10.2017, 14:19 |
|
Заголовочные файлы и С#
|
|||
---|---|---|---|
#18+
"люди, отказывающиеся писать комментарии, A) думают, что их код понятнее, чем мог бы быть, B) считают, что другие программисты гораздо сильнее интересуются их кодом, чем есть на самом деле, C) думают, что другие программисты умнее, чем есть на самом деле, D) ленятся или E) боятся, что кто-то другой узнает, как работает их код." (МакКоннелл) ... |
|||
:
Нравится:
Не нравится:
|
|||
02.10.2017, 14:42 |
|
Заголовочные файлы и С#
|
|||
---|---|---|---|
#18+
Arm79, Кроме того подпроцедуры только появились? Т.е. она у меня используется только один раз, а выглядит как полноценный коммент). "Скажет перфекционист" ))) ... |
|||
:
Нравится:
Не нравится:
|
|||
02.10.2017, 14:46 |
|
Заголовочные файлы и С#
|
|||
---|---|---|---|
#18+
schi, D) ленивый )) ... |
|||
:
Нравится:
Не нравится:
|
|||
02.10.2017, 14:47 |
|
Заголовочные файлы и С#
|
|||
---|---|---|---|
#18+
Petro123Arm79, Работает, но хочется большего. Целиком на документ Свернуть грёбаные комменты и показать только при клике мышкой. Я 95 проц.времени код пишу, а не комменты читаю. При свёрт и развёрт они вместе с кодом мешаются. А в своём коде мне 1 строки достаточно. Память не дырявая. Я с вами не соглашусь. Подход vHostt правильный. В summary писать необходимое описание, включая описание параметров, примеры вызовов и иные моменты. Да, видимость кода может это и понизит (хотя по мне это незначительный фактор, ведь всегда можно свернуть, и свертывание сохраняется), зато всегда можно снегерировать актуальную документацию. Этот момент разработчики упускают. А поддержка доки в актуальном состоянии в ручном режиме - это очень трудная задача. ... |
|||
:
Нравится:
Не нравится:
|
|||
02.10.2017, 15:17 |
|
Заголовочные файлы и С#
|
|||
---|---|---|---|
#18+
Arm79Чем генерируете? Я пробовал SandCastle, но его выходной формат мне не понравился. Разбираться с настройкой своего формата не захотелось. Собственный самописный генератор. Чёт тухловато на просторах на эту тему. SandCastle загнулся, остальное поделки так себе, даже DocFX фигня. ... |
|||
:
Нравится:
Не нравится:
|
|||
02.10.2017, 15:50 |
|
Заголовочные файлы и С#
|
|||
---|---|---|---|
#18+
Arm79хотя по мне это незначительный фактор, ведь всегда можно свернуть, и свертывание сохраняется И всё? Это решение вопроса? Попробуйте C+M,P и потом C+M, L. Главное чтобы вам потом документацию и акт подписывать. Не нужно решать проблемы тонера в принтере и документации за счёт программиста. ... |
|||
:
Нравится:
Не нравится:
|
|||
02.10.2017, 15:54 |
|
Заголовочные файлы и С#
|
|||
---|---|---|---|
#18+
Arm79, Свертываемость кода должна быть независимой от комментов не только прицелом мышки. Тогда всем будет хорошо. ... |
|||
:
Нравится:
Не нравится:
|
|||
02.10.2017, 15:57 |
|
Заголовочные файлы и С#
|
|||
---|---|---|---|
#18+
AddxskyANAАлексей К, вот как понятнее, так: Код: c# 1. 2. 3.
или так: Код: c# 1. 2. 3. 4. 5. 6. 7. 8. 9. 10. 11. 12. 13. 14. 15. 16. 17. 18. 19. 20. 21. 22. 23.
? Встает вопрос. Если вы не можете написать краткий, но исчерпывающий комментарий о том, что делает код, а не как написан, в состоянии ли вы написать сам такой код? Понимаете ли вы, зачем он нужен, логику создания данного класса, его методов и свойств? А так в комментарий еще можно написать свои размышления на эту тему, где и зачем его использовали, ну и пару анекдотов, чтоб не скучно было )) Могли бы и погуглить AutoIndentWriter . Неужели зайдя на страницу по ссылке у Вас складывается впечатление, что информация избыточна? ... |
|||
:
Нравится:
Не нравится:
|
|||
02.10.2017, 20:33 |
|
Заголовочные файлы и С#
|
|||
---|---|---|---|
#18+
schi"люди, отказывающиеся писать комментарии, A) думают, что их код понятнее, чем мог бы быть, B) считают, что другие программисты гораздо сильнее интересуются их кодом, чем есть на самом деле, C) думают, что другие программисты умнее, чем есть на самом деле, D) ленятся или E) боятся, что кто-то другой узнает, как работает их код." (МакКоннелл) +1 ... |
|||
:
Нравится:
Не нравится:
|
|||
02.10.2017, 20:34 |
|
Заголовочные файлы и С#
|
|||
---|---|---|---|
#18+
skyANAschi"люди, отказывающиеся писать комментарии, A) думают, что их код понятнее, чем мог бы быть, B) считают, что другие программисты гораздо сильнее интересуются их кодом, чем есть на самом деле, C) думают, что другие программисты умнее, чем есть на самом деле, D) ленятся или E) боятся, что кто-то другой узнает, как работает их код." (МакКоннелл) +1 F) сами нихрена не понимают что должен делать их код и как его правильно использовать, поэтому ничего написать внятного не в состоянии а потом смеются над картинками про комментарии типа «это мост», ведь это им так близко ... |
|||
:
Нравится:
Не нравится:
|
|||
03.10.2017, 13:25 |
|
Заголовочные файлы и С#
|
|||
---|---|---|---|
#18+
skyANAAddxпропущено... Встает вопрос. Если вы не можете написать краткий, но исчерпывающий комментарий о том, что делает код, а не как написан, в состоянии ли вы написать сам такой код? Понимаете ли вы, зачем он нужен, логику создания данного класса, его методов и свойств? А так в комментарий еще можно написать свои размышления на эту тему, где и зачем его использовали, ну и пару анекдотов, чтоб не скучно было )) Могли бы и погуглить AutoIndentWriter . Неужели зайдя на страницу по ссылке у Вас складывается впечатление, что информация избыточна? Нет, конечно. Я бы и от пары анекдотов не отказался) Если серьезно, то чем больше документации, тем лучше, но требовать писать ее для каждого метода ... Либо ты будешь заниматься только этим вместо разработки, либо сроки вырастут в несколько раз. Чудес не бывает. Впрочем, есть понятие публичной документации. Но у меня то же MSDN никак не проассоциируется с "комментариями к коду". ... |
|||
:
Нравится:
Не нравится:
|
|||
03.10.2017, 16:41 |
|
Заголовочные файлы и С#
|
|||
---|---|---|---|
#18+
AddxЕсли серьезно, то чем больше документации, тем лучше, но требовать писать ее для каждого метода ... Для каждого публичного метода, представляющего контракт. Также есть <inheritdoc />, который снижает болевой порог у людей, которым лень описывать одно и тоже. ... |
|||
:
Нравится:
Не нравится:
|
|||
03.10.2017, 17:41 |
|
Заголовочные файлы и С#
|
|||
---|---|---|---|
#18+
AddxЕсли серьезно, то чем больше документации, тем лучше, но требовать писать ее для каждого метода ... А я требовал? Вроде как я задал вопрос: "И в чём же маразм, если комментарии действительно полезные?". И привёл кусок кода для иллюстрации. ... |
|||
:
Нравится:
Не нравится:
|
|||
03.10.2017, 17:43 |
|
Заголовочные файлы и С#
|
|||
---|---|---|---|
#18+
AddxЛибо ты будешь заниматься только этим вместо разработки, либо сроки вырастут в несколько раз. Чудес не бывает. Без всякой демагогии скажу, что это абсолютная неправда. Создаешь новый публичный тип, сразу пишешь к нему доку, это помогает не только для сопровождения, но и для разработки, когда формируешь свои мысли текстом, организуешь сам процесс в голове. Можешь отвлечься и вернуться к коду, не копаясь в памяти, или тут же передать реализацию другому человеку, это очень хорошо связано с TDD, который тоже ругают «гении от мысли» :) ... |
|||
:
Нравится:
Не нравится:
|
|||
03.10.2017, 17:43 |
|
Заголовочные файлы и С#
|
|||
---|---|---|---|
#18+
Addx, Уже второй год покрываем код докой, и никакой просадки по срокам из-за комментариев не замечено. Зато замечено, что количество тупой коммуникации по типу «а для чего вот этот класс?? а для чего этот метод?? а где найти работу вот с этим??» снизилось практически до нуля. Бывает, что достаточно сказать название типа или метода, и этого достаточно, всё остальное там написано в комментах. Также выяснилось, что очень удобно искать код по русским комментариям, так иногда можно забыть название типа, свойства или метода, особенно если не ты его писал. ... |
|||
:
Нравится:
Не нравится:
|
|||
03.10.2017, 17:46 |
|
Заголовочные файлы и С#
|
|||
---|---|---|---|
#18+
hVostt, Еще есть технический писатель и кондишен. Это снижает болевой порог и повышает ПРОИЗВОДИТЕЛЬНОСТЬ труда. Счас актуальна эффективность). ... |
|||
:
Нравится:
Не нравится:
|
|||
03.10.2017, 17:48 |
|
Заголовочные файлы и С#
|
|||
---|---|---|---|
#18+
hVosttСоздаешь новый публичный тип, сразу пишешь к нему доку, А также Руководство пользователя, и юнит тесты. ... |
|||
:
Нравится:
Не нравится:
|
|||
03.10.2017, 17:51 |
|
Заголовочные файлы и С#
|
|||
---|---|---|---|
#18+
Petro123hVostt, Еще есть технический писатель и кондишен. Это снижает болевой порог и повышает ПРОИЗВОДИТЕЛЬНОСТЬ труда. Счас актуальна эффективность). Ну есть тех. писатель, но у него много другой работы :) ... |
|||
:
Нравится:
Не нравится:
|
|||
03.10.2017, 17:57 |
|
Заголовочные файлы и С#
|
|||
---|---|---|---|
#18+
Petro123hVosttСоздаешь новый публичный тип, сразу пишешь к нему доку, А также Руководство пользователя, и юнит тесты. Руководство пользователя, это не к разработчикам :) Тем более, мы стараемся писать такие системы, где пользователю будет предложено выполнить его задачи при входе, без талмуда, зайди туда, щёлкни сюда, ещё раз щёлкни, «провались» и т.д. Такого нет :) ... |
|||
:
Нравится:
Не нравится:
|
|||
03.10.2017, 17:59 |
|
|
start [/forum/topic.php?fid=20&msg=39529442&tid=1399635]: |
0ms |
get settings: |
9ms |
get forum list: |
16ms |
check forum access: |
4ms |
check topic access: |
4ms |
track hit: |
123ms |
get topic data: |
11ms |
get forum data: |
3ms |
get page messages: |
56ms |
get tp. blocked users: |
1ms |
others: | 13ms |
total: | 240ms |
0 / 0 |