powered by simpleCommunicator - 2.0.53     © 2025 Programmizd 02
Форумы / WinForms, .Net Framework [игнор отключен] [закрыт для гостей] / Как сослаться на свойство в комментарии внутри метода
25 сообщений из 33, страница 1 из 2
Как сослаться на свойство в комментарии внутри метода
    #39414949
Rock Amadeus
Скрыть профиль Поместить в игнор-лист Сообщения автора в теме
Участник
Дожили. МС поддерживает документацию в джаваскрипте лучше, чем в сишарпе.

https://msdn.microsoft.com/en-us/library/hh542722(v=vs.110).aspx

Захотел сделать коммент внутри метода, в котором хочу сослаться на свойство, находящееся в том же классе, что и этот метод. А в сишарпе это нельзя.

Например

Код: c#
1.
2.
3.
4.
5.
6.
7.
8.
9.
10.
11.
12.
13.
    class Program
    {
        /// <summary>
        /// Lovely for cats.
        /// </summary>
        static int fish;

        static void Main(string[] args)
        {
            // Cats likes fish.
            int cat = fish * 2;
        }
    }



заменяю поле fish на dog и должен потом искать все места упоминания fish в комментариях вручную. А хотелось бы что-то типа

Код: c#
1.
// Cats likes <see cref="fish"/>.



Да, есть автозамена, но она тупая и надо вручную все места прогнать, где упоминается текст "fish" в комментах, а не только те, где fish упоминается как ссылка на поле fish.
...
Рейтинг: 0 / 0
Как сослаться на свойство в комментарии внутри метода
    #39414950
Rock Amadeus
Скрыть профиль Поместить в игнор-лист Сообщения автора в теме
Участник
А, ну да. Название неправильное - не на свойство сослаться, а на поле. Но сути это не меняет - на поле, свойство, метод и т. д.
...
Рейтинг: 0 / 0
Как сослаться на свойство в комментарии внутри метода
    #39415108
Фотография hVostt
Скрыть профиль Поместить в игнор-лист Сообщения автора в теме
Участник
Rock Amadeus,

По-моему это лишнее. Подробности реализации обычно редко комментируются, хорошая декомпозиция убирает эту необходимость.

Тебе проще вынести в приватную функцию кусок кода и прокомментировать его со всеми удобствами. Компилятор его если что заинлайнит.
...
Рейтинг: 0 / 0
Как сослаться на свойство в комментарии внутри метода
    #39415124
Rock Amadeus
Скрыть профиль Поместить в игнор-лист Сообщения автора в теме
Участник
hVosttRock Amadeus,

По-моему это лишнее. Подробности реализации обычно редко комментируются, хорошая декомпозиция убирает эту необходимость.

Тебе проще вынести в приватную функцию кусок кода и прокомментировать его со всеми удобствами. Компилятор его если что заинлайнит.
Т. е. ты предлагаешь вынести кусок алгоритма в функцию и комментить его через комментарии для функции, вместо того, чтобы прямо внутри кода к каждой строчке добавить коммент? Согласись, звучит как долбаный сишарпный костыль, а не "проще"?

Вот в джаваскрипте почему-то решили, что проще для переменной внутри блока кода сделать возможность комментировать.

Ну, т. е. пока в сишарп таких возможностей не ввели, да? А то я думал, что плохо искал. В комментах на StackOverflow за 11 год пишут, что нельзя.
...
Рейтинг: 0 / 0
Как сослаться на свойство в комментарии внутри метода
    #39415149
Фотография hVostt
Скрыть профиль Поместить в игнор-лист Сообщения автора в теме
Участник
Rock AmadeusТ. е. ты предлагаешь вынести кусок алгоритма в функцию и комментить его через комментарии для функции, вместо того, чтобы прямо внутри кода к каждой строчке добавить коммент? Согласись, звучит как долбаный сишарпный костыль, а не "проще"?

Нет, не соглашусь. Это вообще не имеет отношения конкретно к сишарпу. Это имеет отношение к программированию вообще, практически к любому языку. Большие функцию для того и дробятся на маленькие, чтобы код стал лучше, понятней, и был самодокументрованным.

Пусть и немного утрировано, но смотри:

Код: c#
1.
2.
3.
4.
private int CatLikeFish(int fish)
{
   return fish * 2;
}



Уже ничего не надо даже комментировать. А если очень хочется, ты можешь добавить XML DOC комментарий со всеми плюшками.

Rock AmadeusВот в джаваскрипте почему-то решили, что проще для переменной внутри блока кода сделать возможность комментировать.

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

Rock AmadeusНу, т. е. пока в сишарп таких возможностей не ввели, да? А то я думал, что плохо искал. В комментах на StackOverflow за 11 год пишут, что нельзя.

Потому что не надо. Потому что необходимость писать комментарии внутри блока это уже попахивает. Всё должно быть разбито на функции. Так Гай Юлий Цезарь сказал. Не я
...
Рейтинг: 0 / 0
Как сослаться на свойство в комментарии внутри метода
    #39415289
Roman Mejtes
Скрыть профиль Поместить в игнор-лист Сообщения автора в теме
Участник
Описывать и ссылаться на локальные переменные метода в классе? в другом namescope?
комментарий просто размещен неправильно, а связь между собакой\рыбой и кошкой в данном контексте не имеют смысла.
Комментарий должен описывать то, к чему имеет отношение, можно указать в каких методах он используется и т.д. Но какой смысл описывать то, как он взаимодействует с внутренней реализацией метода? это должно описываться в самом методе.

https://msdn.microsoft.com/ru-ru/library/cc837134.aspx
https://msdn.microsoft.com/ru-ru/library/fsbx0t7x.aspx
...
Рейтинг: 0 / 0
Как сослаться на свойство в комментарии внутри метода
    #39415339
Фотография hVostt
Скрыть профиль Поместить в игнор-лист Сообщения автора в теме
Участник
Roman Mejtes,

XML возможности в комментариях к функциям нужны для генерации документации. Комментарии внутри реализации метода в документацию тащить не имеет смысла, соответственно нафиг не нужны эти заморочки. В общем хотелка из разряда в "масле каши не хватает".
...
Рейтинг: 0 / 0
Как сослаться на свойство в комментарии внутри метода
    #39415654
Rock Amadeus
Скрыть профиль Поместить в игнор-лист Сообщения автора в теме
Участник
Я тут подумал и, вобщем, я согласен, что XML-комментарии тут не нужны. Я просто хотел отслеживать изменения названий членов класса, упоминаемых внутри комментариев в методах этого класса. Хотел использовать для этого механизм XML-комментариев, т. к. если название элемента в ссылке и в оригинале не совпадает, то Студия выдаёт предупреждение.

Так-то да - описание алгоритма не нужно читать по XML-комментариям, которые во всплывающих подсказках появляются. Их нужно читать в обычных комментариях в коде.

Тогда как отслеживать изменений названий членов класса? Я же не должен при каждом переименовании шерстить весь код во всех методах класса, чтобы поправить и там тоже. Да, встроенный рефакторинг "переименование" предлагает поискать такую же строковую комбинацию в комментах и строковых данных, но если кода в классе много то шерстить неперешерстить. Если я активно переименовываю, то куча времени на поиски совпадений в комментах и строках уходит.

Т. е. ничего лучше рефакторинга "переименование" со строковым поиском пока не придумали?
...
Рейтинг: 0 / 0
Как сослаться на свойство в комментарии внутри метода
    #39415672
Фотография hVostt
Скрыть профиль Поместить в игнор-лист Сообщения автора в теме
Участник
Rock AmadeusТ. е. ничего лучше рефакторинга "переименование" со строковым поиском пока не придумали?

Ну решапер бодро находит все упоминания во всех комментах и предлагает переименовать при рефакторинге. Проблему решает, чего ещё тут можно придумать?
...
Рейтинг: 0 / 0
Как сослаться на свойство в комментарии внутри метода
    #39415673
Rock Amadeus
Скрыть профиль Поместить в игнор-лист Сообщения автора в теме
Участник
hVosttRock AmadeusТ. е. ничего лучше рефакторинга "переименование" со строковым поиском пока не придумали?

Ну решапер бодро находит все упоминания во всех комментах и предлагает переименовать при рефакторинге. Проблему решает, чего ещё тут можно придумать?
Понятно.
...
Рейтинг: 0 / 0
Как сослаться на свойство в комментарии внутри метода
    #39415674
Rock Amadeus
Скрыть профиль Поместить в игнор-лист Сообщения автора в теме
Участник
hVosttRock AmadeusТ. е. ничего лучше рефакторинга "переименование" со строковым поиском пока не придумали?

Ну решапер бодро находит все упоминания во всех комментах и предлагает переименовать при рефакторинге. Проблему решает, чего ещё тут можно придумать?
Ты, кстати, пробовал поработать на современной Студии без Решарпера? Как оно? "Как бер рук", или "есть почти все аналоги"?
...
Рейтинг: 0 / 0
Как сослаться на свойство в комментарии внутри метода
    #39415681
Фотография hVostt
Скрыть профиль Поместить в игнор-лист Сообщения автора в теме
Участник
Rock AmadeusТы, кстати, пробовал поработать на современной Студии без Решарпера? Как оно? "Как бер рук", или "есть почти все аналоги"?

Не, я без решарпера не работаю в студии. Да можно без решарпера жить и нормально работать. Но с ним жить намного лучше. Поэтому у меня лицуха на линейку продуктов JetBrains на 3 года вперёд. Я не сторонник ограничивать себя в комфорте ))
...
Рейтинг: 0 / 0
Как сослаться на свойство в комментарии внутри метода
    #39415688
Rock Amadeus
Скрыть профиль Поместить в игнор-лист Сообщения автора в теме
Участник
hVosttRock AmadeusТы, кстати, пробовал поработать на современной Студии без Решарпера? Как оно? "Как бер рук", или "есть почти все аналоги"?

Не, я без решарпера не работаю в студии. Да можно без решарпера жить и нормально работать. Но с ним жить намного лучше. Поэтому у меня лицуха на линейку продуктов JetBrains на 3 года вперёд. Я не сторонник ограничивать себя в комфорте ))
Я видел в разных видео обучающих чуваков, которые по быстрым клавишам "летают". Класс создать - хлоп, и заглушка появляется. Метод там, проперти - всё мгновенно. Видно, что чел юзает какие-то комбинации быстрые. Я, например, почти ничем подобным не пользуюсь. Есть смысл Решарпер юзать, если тебе не нужны куча быстрокнопочных вставок шаблонов на все случаи жизни? Или он ещё и компилятор подменяет, предлагая рефакторинги на лету и вообще "вот тут можно лучше написать"?
...
Рейтинг: 0 / 0
Как сослаться на свойство в комментарии внутри метода
    #39415694
Фотография hVostt
Скрыть профиль Поместить в игнор-лист Сообщения автора в теме
Участник
Rock AmadeusЯ видел в разных видео обучающих чуваков, которые по быстрым клавишам "летают". Класс создать - хлоп, и заглушка появляется. Метод там, проперти - всё мгновенно.

Много чего нехватает даже при богатых и развитых возможностях студии. Например, поддержка атрибутов [NotNull] / [CanBeNull], вставка проверок на null и генерация исключений, верблюжий язык (быстро находишь класс, интерфейс, расширение или метод по первым большим буквам), генерация имён переменных на лету, автосоздание out переменных, всякие обёртывания/развёртывания, генерация регионов при имплементации интерфейсов и при переопределении методов, генерация конструкторов, дженерик-типов, грамотная декомпозиция, и т.д, и т.п. Студия умеет много, но до решарпера ей очень далеко.
...
Рейтинг: 0 / 0
Как сослаться на свойство в комментарии внутри метода
    #39415758
Rock Amadeus
Скрыть профиль Поместить в игнор-лист Сообщения автора в теме
Участник
hVosttграмотная декомпозиция
Это точно рутина, которую надо автоматизировать, или уже AI пишет за тебя не только код, но и по мелочи архитектуру?
...
Рейтинг: 0 / 0
Как сослаться на свойство в комментарии внутри метода
    #39415787
Фотография hVostt
Скрыть профиль Поместить в игнор-лист Сообщения автора в теме
Участник
Rock AmadeusЭто точно рутина, которую надо автоматизировать, или уже AI пишет за тебя не только код, но и по мелочи архитектуру?

Растащить метод по нескольким методам или выделить класс, это не архитектура :)
...
Рейтинг: 0 / 0
Как сослаться на свойство в комментарии внутри метода
    #39415840
Roman Mejtes
Скрыть профиль Поместить в игнор-лист Сообщения автора в теме
Участник
Rock Amadeus,

для этого есть Snippet'ы, да комбинаций в коде полно.
не так давно отказался от использования решарпера, особенно всё хорошо стало в 2017 версии VS, в Enterprice версии он практически не нужен, так как тупо дублирует половину функционала который уже там есть. + решарпер тормозит очень злостно, без SSD работать становится не комфортно.
...
Рейтинг: 0 / 0
Как сослаться на свойство в комментарии внутри метода
    #39415878
Фотография hVostt
Скрыть профиль Поместить в игнор-лист Сообщения автора в теме
Участник
Roman Mejtesдля этого есть Snippet'ы, да комбинаций в коде полно.

Я не спорю, но многих возможностей решарпера либо нет, либо как-то криво воспроизводятся другими расширениями.


Roman Mejtesне так давно отказался от использования решарпера, особенно всё хорошо стало в 2017 версии VS, в Enterprice версии он практически не нужен, так как тупо дублирует половину функционала который уже там есть. + решарпер тормозит очень злостно, без SSD работать становится не комфортно.

Не знаю, у меня ничего не тормозит :) Тем более, что на подходе Rider, построенный на решарпере. Так что удобно, что не надо переучиваться, и юзать новый тул при необходимости.
...
Рейтинг: 0 / 0
Как сослаться на свойство в комментарии внутри метода
    #39415972
Rock Amadeus
Скрыть профиль Поместить в игнор-лист Сообщения автора в теме
Участник
hVosttНе знаю, у меня ничего не тормозит.
Разогнанный 8-ядерный Core i7 и SSD для ОС и проектов?
...
Рейтинг: 0 / 0
Как сослаться на свойство в комментарии внутри метода
    #39415973
Rock Amadeus
Скрыть профиль Поместить в игнор-лист Сообщения автора в теме
Участник
Так-то ещё зависит, сколько всего загружено с этой Студией. Может, доп. расширения. Может, проктов несколько десятков в одном солюшене и кодовая база под миллион строк.

Или Roman Mejtes имеет ввиду, что Решарпер у него тормозит всегда, даже на хеллоуворлдовских проектах?
...
Рейтинг: 0 / 0
Как сослаться на свойство в комментарии внутри метода
    #39415974
Фотография hVostt
Скрыть профиль Поместить в игнор-лист Сообщения автора в теме
Участник
Rock AmadeusРазогнанный 8-ядерный Core i7 и SSD для ОС и проектов?

Зачем разогнанный? Нет, в обычном режиме Core i7 6700-HQ, вообще тормозов не замечал.
Другое дело, непонятны жалобы на тормоза на слабой машине. Для разработки нужно мощное железо, и дело тут не только в студии и решарпере.
...
Рейтинг: 0 / 0
Как сослаться на свойство в комментарии внутри метода
    #39415975
Фотография hVostt
Скрыть профиль Поместить в игнор-лист Сообщения автора в теме
Участник
Rock AmadeusТак-то ещё зависит, сколько всего загружено с этой Студией. Может, доп. расширения. Может, проктов несколько десятков в одном солюшене и кодовая база под миллион строк.

В том-то и дело, что с решарпером, лишние расширения практически не нужны. Засовывать в один солюшен дофигища проектов не благодарное дело, "да у меня в солюшене +100500 проэктаф!!" -- сомнительное и нелепое удовольствие, когда можно поднять нугет и делать независимые проекты, всё по феншую.

Но даж так можно выгружать проекты в открытом солюшене и загружать по мере необходимости.

Нет такой острой проблемы, о которой многие почему-то жалуются. В любом случае можно уже скачать и пощупать Rider, который ощутимо по-быстрее студии.
...
Рейтинг: 0 / 0
Как сослаться на свойство в комментарии внутри метода
    #39416015
Rock Amadeus
Скрыть профиль Поместить в игнор-лист Сообщения автора в теме
Участник
hVosttВ том-то и дело, что с решарпером, лишние расширения практически не нужны. Засовывать в один солюшен дофигища проектов не благодарное дело, "да у меня в солюшене +100500 проэктаф!!" -- сомнительное и нелепое удовольствие, когда можно поднять нугет и делать независимые проекты, всё по феншую.
Я, может, что-то не то делаю, но когда надо весь проект в сборе под дебагом смотреть, то там все проекты должны быть включены, чтобы не было проблем с переходом к нужному коду. Со всякими символьными сборками у меня чего-то не заладилось. Есть ситуации, когда их либо нет, либо они не работают. Я не стал разбираться, а заметил, что если проекты все включены в солюшен, то проблем не возникает и под дебагом к коду другого проекта нормально переходит. А раньше тоже пытался по одному-три проекта в солюшене держать, не больше.
...
Рейтинг: 0 / 0
Как сослаться на свойство в комментарии внутри метода
    #39416018
Rock Amadeus
Скрыть профиль Поместить в игнор-лист Сообщения автора в теме
Участник
hVosttВ том-то и дело, что с решарпером, лишние расширения практически не нужны.
В Решарпере есть кодовая миникарта (крайний правый край), как в Sublime? Для Студии есть расширение, которое в последних версиях уже встроили в саму Студию, где это не просто миникарта, а там куча отметок полезных есть - от точек останова до визуального отображения длины кодовых блоков и прочее.

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

Я раньше это всё сторонними расширениями подключал.
...
Рейтинг: 0 / 0
Как сослаться на свойство в комментарии внутри метода
    #39416029
Фотография hVostt
Скрыть профиль Поместить в игнор-лист Сообщения автора в теме
Участник
Rock AmadeusВ Решарпере есть кодовая миникарта (крайний правый край), как в Sublime? Для Студии есть расширение, которое в последних версиях уже встроили в саму Студию, где это не просто миникарта, а там куча отметок полезных есть - от точек останова до визуального отображения длины кодовых блоков и прочее.

Что касается отметок, то отметки есть прямо на скроллбаре, кликабельные, этого обычно более чем достаточно. Кодовая миникарта наверное может быть полезна для длинных портянок кода. У нас жёсткий стайлгайд на этот счёт. Длинных портянок кода просто нет, поэтому кодовая миникарта бесполезна.


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

Есть такое.
...
Рейтинг: 0 / 0
25 сообщений из 33, страница 1 из 2
Форумы / WinForms, .Net Framework [игнор отключен] [закрыт для гостей] / Как сослаться на свойство в комментарии внутри метода
Целевая тема:
Создать новую тему:
Автор:
Закрыть
Цитировать
Найденые пользователи ...
Разблокировать пользователей ...
Читали форум (0):
Пользователи онлайн (0):
x
x
Закрыть


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