powered by simpleCommunicator - 2.0.51     © 2025 Programmizd 02
Форумы / WinForms, .Net Framework [игнор отключен] [закрыт для гостей] / Заголовочные файлы и С#
25 сообщений из 81, страница 3 из 4
Заголовочные файлы и С#
    #39529283
Фотография skyANA
Скрыть профиль Поместить в игнор-лист Сообщения автора в теме
Участник
Petro123skyANAпропущено...
Покликай правой кнопкой мыши и посмотри комбинации клавиш.
Алексей К, тебе ответил.
Обозреватель структуры WPF появился в 2015upd3. Почти тоже самое но не то есть в WinForms.
Даже в ворде Это есть )))))
?
...
Рейтинг: 0 / 0
Заголовочные файлы и С#
    #39529294
Фотография Petro123
Скрыть профиль Поместить в игнор-лист Сообщения автора в теме
Участник
skyANA?
Word меню, 5 режимов просмотра документа.
Аналогия понятна?
У нас только один.
...
Рейтинг: 0 / 0
Заголовочные файлы и С#
    #39529314
Addx
Скрыть профиль Поместить в игнор-лист Сообщения автора в теме
Участник
skyANAАлексей К,

вот как понятнее, так:
Код: c#
1.
2.
3.
public class AutoIndentWriter : IStringTemplateWriter
{
    protected int charPosition;


или так:
Код: c#
1.
2.
3.
4.
5.
6.
7.
8.
9.
10.
11.
12.
13.
14.
15.
16.
17.
18.
19.
20.
21.
22.
23.
/// <summary>
/// Essentially a char filter that knows how to auto-indent output
/// by maintaining a stack of indent levels. I set a flag upon newline
/// and then next nonwhitespace char resets flag and spits out indention.
/// The indent stack is a stack of strings so we can repeat original indent
/// not just the same number of columns (don't have to worry about tabs vs spaces then).
/// 
/// Anchors are char positions (tabs won't work) that indicate where all
/// future wraps should justify to. The wrap position is actually the
/// larger of either the last anchor or the indentation level.
/// 
/// This is a filter on a Writer.
/// 
/// It may be screwed up for '\r' '\n' on PC's.
/// </summary>
public class AutoIndentWriter : IStringTemplateWriter
{
    /// <summary>
    /// Track char position in the line (later we can think about tabs).
    /// Indexed from 0. We want to keep <![CDATA[charPosition <= lineWidth]]>.
    /// This is the position we are *about* to write not the position last written to.
    /// </summary>
    protected int charPosition;


?

Встает вопрос.
Если вы не можете написать краткий, но исчерпывающий комментарий о том, что делает код, а не как написан, в состоянии ли вы написать сам такой код? Понимаете ли вы, зачем он нужен, логику создания данного класса, его методов и свойств?
А так в комментарий еще можно написать свои размышления на эту тему, где и зачем его использовали, ну и пару анекдотов, чтоб не скучно было ))
...
Рейтинг: 0 / 0
Заголовочные файлы и С#
    #39529358
Ролг Хупин
Скрыть профиль Поместить в игнор-лист Сообщения автора в теме
Участник
Petro123Вы с позиции начальства говорите), а я с позиции программиста).
Код в коде должен быть понятен программисту, а не вам)).
Есть вилка максималистов. На соседней ветке чел весь код увешал комметами. И есть те, кто вообще не ставит. Я посередине)
Разумная достаточность. (С)
Про обозреваемость кода:
- кто при открытии кода лезет не в файл, а в обозреватель классов?
- почему ide не группирует вместе public/private?
- почему по умолчанию новый метод она ставит internal?


группа "Звери"
...
Рейтинг: 0 / 0
Заголовочные файлы и С#
    #39529382
Arm79
Скрыть профиль Поместить в игнор-лист Сообщения автора в теме
Участник
hVosttПотом при сборке генерится документация и выкладываеся в вики автоматом
Чем генерируете? Я пробовал SandCastle, но его выходной формат мне не понравился. Разбираться с настройкой своего формата не захотелось.
Petro123У меня методы размер с экран и треть отдать под описание что я делал?
А что, сворачивание не работает?
...
Рейтинг: 0 / 0
Заголовочные файлы и С#
    #39529396
Фотография Petro123
Скрыть профиль Поместить в игнор-лист Сообщения автора в теме
Участник
Arm79,
Работает, но хочется большего.
Целиком на документ Свернуть грёбаные комменты и показать только при клике мышкой.
Я 95 проц.времени код пишу, а не комменты читаю.
При свёрт и развёрт они вместе с кодом мешаются.
А в своём коде мне 1 строки достаточно.
Память не дырявая.
...
Рейтинг: 0 / 0
Заголовочные файлы и С#
    #39529409
schi
Скрыть профиль Поместить в игнор-лист Сообщения автора в теме
Участник
"люди, отказывающиеся писать комментарии, A) думают, что их код понятнее, чем мог бы быть, B) считают, что другие программисты гораздо сильнее интересуются их кодом, чем есть на самом деле, C) думают, что другие программисты умнее, чем есть на самом деле, D) ленятся или E) боятся, что кто-то другой узнает, как работает их код."

(МакКоннелл)
...
Рейтинг: 0 / 0
Заголовочные файлы и С#
    #39529413
Фотография Petro123
Скрыть профиль Поместить в игнор-лист Сообщения автора в теме
Участник
Arm79,
Кроме того подпроцедуры только появились?
Т.е. она у меня используется только один раз, а выглядит как полноценный коммент).
"Скажет перфекционист" )))
...
Рейтинг: 0 / 0
Заголовочные файлы и С#
    #39529414
Фотография Petro123
Скрыть профиль Поместить в игнор-лист Сообщения автора в теме
Участник
schi,
D) ленивый ))
...
Рейтинг: 0 / 0
Заголовочные файлы и С#
    #39529442
Arm79
Скрыть профиль Поместить в игнор-лист Сообщения автора в теме
Участник
Petro123Arm79,
Работает, но хочется большего.
Целиком на документ Свернуть грёбаные комменты и показать только при клике мышкой.
Я 95 проц.времени код пишу, а не комменты читаю.
При свёрт и развёрт они вместе с кодом мешаются.
А в своём коде мне 1 строки достаточно.
Память не дырявая.
Я с вами не соглашусь. Подход vHostt правильный. В summary писать необходимое описание, включая описание параметров, примеры вызовов и иные моменты. Да, видимость кода может это и понизит (хотя по мне это незначительный фактор, ведь всегда можно свернуть, и свертывание сохраняется), зато всегда можно снегерировать актуальную документацию. Этот момент разработчики упускают. А поддержка доки в актуальном состоянии в ручном режиме - это очень трудная задача.
...
Рейтинг: 0 / 0
Заголовочные файлы и С#
    #39529484
Фотография hVostt
Скрыть профиль Поместить в игнор-лист Сообщения автора в теме
Участник
Arm79Чем генерируете? Я пробовал SandCastle, но его выходной формат мне не понравился. Разбираться с настройкой своего формата не захотелось.

Собственный самописный генератор. Чёт тухловато на просторах на эту тему. SandCastle загнулся, остальное поделки так себе, даже DocFX фигня.
...
Рейтинг: 0 / 0
Заголовочные файлы и С#
    #39529490
Фотография Petro123
Скрыть профиль Поместить в игнор-лист Сообщения автора в теме
Участник
Arm79хотя по мне это незначительный фактор, ведь всегда можно свернуть, и свертывание сохраняется
И всё? Это решение вопроса?
Попробуйте C+M,P и потом C+M, L.
Главное чтобы вам потом документацию и акт подписывать.
Не нужно решать проблемы тонера в принтере и документации за счёт программиста.
...
Рейтинг: 0 / 0
Заголовочные файлы и С#
    #39529497
Фотография Petro123
Скрыть профиль Поместить в игнор-лист Сообщения автора в теме
Участник
Arm79,
Свертываемость кода должна быть независимой от комментов не только прицелом мышки.
Тогда всем будет хорошо.
...
Рейтинг: 0 / 0
Заголовочные файлы и С#
    #39529675
Фотография skyANA
Скрыть профиль Поместить в игнор-лист Сообщения автора в теме
Участник
AddxskyANAАлексей К,

вот как понятнее, так:
Код: c#
1.
2.
3.
public class AutoIndentWriter : IStringTemplateWriter
{
    protected int charPosition;



или так:
Код: c#
1.
2.
3.
4.
5.
6.
7.
8.
9.
10.
11.
12.
13.
14.
15.
16.
17.
18.
19.
20.
21.
22.
23.
/// <summary>
/// Essentially a char filter that knows how to auto-indent output
/// by maintaining a stack of indent levels. I set a flag upon newline
/// and then next nonwhitespace char resets flag and spits out indention.
/// The indent stack is a stack of strings so we can repeat original indent
/// not just the same number of columns (don't have to worry about tabs vs spaces then).
/// 
/// Anchors are char positions (tabs won't work) that indicate where all
/// future wraps should justify to. The wrap position is actually the
/// larger of either the last anchor or the indentation level.
/// 
/// This is a filter on a Writer.
/// 
/// It may be screwed up for '\r' '\n' on PC's.
/// </summary>
public class AutoIndentWriter : IStringTemplateWriter
{
    /// <summary>
    /// Track char position in the line (later we can think about tabs).
    /// Indexed from 0. We want to keep <![CDATA[charPosition <= lineWidth]]>.
    /// This is the position we are *about* to write not the position last written to.
    /// </summary>
    protected int charPosition;



?

Встает вопрос.
Если вы не можете написать краткий, но исчерпывающий комментарий о том, что делает код, а не как написан, в состоянии ли вы написать сам такой код? Понимаете ли вы, зачем он нужен, логику создания данного класса, его методов и свойств?
А так в комментарий еще можно написать свои размышления на эту тему, где и зачем его использовали, ну и пару анекдотов, чтоб не скучно было ))
Могли бы и погуглить AutoIndentWriter .
Неужели зайдя на страницу по ссылке у Вас складывается впечатление, что информация избыточна?
...
Рейтинг: 0 / 0
Заголовочные файлы и С#
    #39529676
Фотография skyANA
Скрыть профиль Поместить в игнор-лист Сообщения автора в теме
Участник
schi"люди, отказывающиеся писать комментарии, A) думают, что их код понятнее, чем мог бы быть, B) считают, что другие программисты гораздо сильнее интересуются их кодом, чем есть на самом деле, C) думают, что другие программисты умнее, чем есть на самом деле, D) ленятся или E) боятся, что кто-то другой узнает, как работает их код."

(МакКоннелл)
+1
...
Рейтинг: 0 / 0
Заголовочные файлы и С#
    #39530121
Фотография hVostt
Скрыть профиль Поместить в игнор-лист Сообщения автора в теме
Участник
skyANAschi"люди, отказывающиеся писать комментарии, A) думают, что их код понятнее, чем мог бы быть, B) считают, что другие программисты гораздо сильнее интересуются их кодом, чем есть на самом деле, C) думают, что другие программисты умнее, чем есть на самом деле, D) ленятся или E) боятся, что кто-то другой узнает, как работает их код."

(МакКоннелл)
+1

F) сами нихрена не понимают что должен делать их код и как его правильно использовать, поэтому ничего написать внятного не в состоянии

а потом смеются над картинками про комментарии типа «это мост», ведь это им так близко
...
Рейтинг: 0 / 0
Заголовочные файлы и С#
    #39530316
Addx
Скрыть профиль Поместить в игнор-лист Сообщения автора в теме
Участник
skyANAAddxпропущено...


Встает вопрос.
Если вы не можете написать краткий, но исчерпывающий комментарий о том, что делает код, а не как написан, в состоянии ли вы написать сам такой код? Понимаете ли вы, зачем он нужен, логику создания данного класса, его методов и свойств?
А так в комментарий еще можно написать свои размышления на эту тему, где и зачем его использовали, ну и пару анекдотов, чтоб не скучно было ))
Могли бы и погуглить AutoIndentWriter .
Неужели зайдя на страницу по ссылке у Вас складывается впечатление, что информация избыточна?

Нет, конечно.
Я бы и от пары анекдотов не отказался)
Если серьезно, то чем больше документации, тем лучше, но требовать писать ее для каждого метода ...
Либо ты будешь заниматься только этим вместо разработки, либо сроки вырастут в несколько раз.
Чудес не бывает.
Впрочем, есть понятие публичной документации. Но у меня то же MSDN никак не проассоциируется с "комментариями к коду".
...
Рейтинг: 0 / 0
Заголовочные файлы и С#
    #39530394
Фотография hVostt
Скрыть профиль Поместить в игнор-лист Сообщения автора в теме
Участник
AddxЕсли серьезно, то чем больше документации, тем лучше, но требовать писать ее для каждого метода ...

Для каждого публичного метода, представляющего контракт. Также есть <inheritdoc />, который снижает болевой порог у людей, которым лень описывать одно и тоже.
...
Рейтинг: 0 / 0
Заголовочные файлы и С#
    #39530401
Фотография skyANA
Скрыть профиль Поместить в игнор-лист Сообщения автора в теме
Участник
AddxЕсли серьезно, то чем больше документации, тем лучше, но требовать писать ее для каждого метода ...
А я требовал?
Вроде как я задал вопрос: "И в чём же маразм, если комментарии действительно полезные?". И привёл кусок кода для иллюстрации.
...
Рейтинг: 0 / 0
Заголовочные файлы и С#
    #39530402
Фотография hVostt
Скрыть профиль Поместить в игнор-лист Сообщения автора в теме
Участник
AddxЛибо ты будешь заниматься только этим вместо разработки, либо сроки вырастут в несколько раз.
Чудес не бывает.

Без всякой демагогии скажу, что это абсолютная неправда. Создаешь новый публичный тип, сразу пишешь к нему доку, это помогает не только для сопровождения, но и для разработки, когда формируешь свои мысли текстом, организуешь сам процесс в голове. Можешь отвлечься и вернуться к коду, не копаясь в памяти, или тут же передать реализацию другому человеку, это очень хорошо связано с TDD, который тоже ругают «гении от мысли» :)
...
Рейтинг: 0 / 0
Заголовочные файлы и С#
    #39530409
Фотография hVostt
Скрыть профиль Поместить в игнор-лист Сообщения автора в теме
Участник
Addx,

Уже второй год покрываем код докой, и никакой просадки по срокам из-за комментариев не замечено. Зато замечено, что количество тупой коммуникации по типу «а для чего вот этот класс?? а для чего этот метод?? а где найти работу вот с этим??» снизилось практически до нуля. Бывает, что достаточно сказать название типа или метода, и этого достаточно, всё остальное там написано в комментах. Также выяснилось, что очень удобно искать код по русским комментариям, так иногда можно забыть название типа, свойства или метода, особенно если не ты его писал.
...
Рейтинг: 0 / 0
Заголовочные файлы и С#
    #39530411
Фотография Petro123
Скрыть профиль Поместить в игнор-лист Сообщения автора в теме
Участник
hVostt,
Еще есть технический писатель и кондишен.
Это снижает болевой порог и повышает ПРОИЗВОДИТЕЛЬНОСТЬ труда.
Счас актуальна эффективность).
...
Рейтинг: 0 / 0
Заголовочные файлы и С#
    #39530414
Фотография Petro123
Скрыть профиль Поместить в игнор-лист Сообщения автора в теме
Участник
hVosttСоздаешь новый публичный тип, сразу пишешь к нему доку,
А также Руководство пользователя, и юнит тесты.
...
Рейтинг: 0 / 0
Заголовочные файлы и С#
    #39530425
Фотография hVostt
Скрыть профиль Поместить в игнор-лист Сообщения автора в теме
Участник
Petro123hVostt,
Еще есть технический писатель и кондишен.
Это снижает болевой порог и повышает ПРОИЗВОДИТЕЛЬНОСТЬ труда.
Счас актуальна эффективность).

Ну есть тех. писатель, но у него много другой работы :)
...
Рейтинг: 0 / 0
Заголовочные файлы и С#
    #39530426
Фотография hVostt
Скрыть профиль Поместить в игнор-лист Сообщения автора в теме
Участник
Petro123hVosttСоздаешь новый публичный тип, сразу пишешь к нему доку,
А также Руководство пользователя, и юнит тесты.

Руководство пользователя, это не к разработчикам :)
Тем более, мы стараемся писать такие системы, где пользователю будет предложено выполнить его задачи при входе, без талмуда, зайди туда, щёлкни сюда, ещё раз щёлкни, «провались» и т.д. Такого нет :)
...
Рейтинг: 0 / 0
25 сообщений из 81, страница 3 из 4
Форумы / WinForms, .Net Framework [игнор отключен] [закрыт для гостей] / Заголовочные файлы и С#
Целевая тема:
Создать новую тему:
Автор:
Закрыть
Цитировать
Найденые пользователи ...
Разблокировать пользователей ...
Читали форум (0):
Пользователи онлайн (0):
x
x
Закрыть


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