Как создать описания для процедур и функций для собственного класса?

@kritjara · Регистрация: 22.10.2012

Студворк — интернет-сервис помощи студентам

В Visual Studio для всех процедур и функций различный классов созданы описания, т.е. кратко рассказывается что выполняет выбранная процедура или функция.

Как создать описания для процедур и функций для собственного класса?

Как создать такие же описания для своих классов?

Someone007 · 25.02.2019, 23:20

Documenting your code with XML comments

@MrCrown · 26.02.2019, 11:03

kritjara, расскажу более популярно.
1. Пишете функцию (класс, процедуру, свойство)
2. Ставите курсор строчкой выше
3. Пишете ''' (три апострофа)
4. Студия автоматически генерирует XML- шаблон для комментария
5. Заполняете теги вашими комментариями

И уже после этого вы можете видеть их в подсказке Intellisence

VB.NET
1
2
3
4
5
6
7
8
9
10
''' <summary>
    ''' Это моя функция, которая возвращает...
    ''' </summary>
    ''' <param name="arg1">Этот аргумент для того, чтобы...</param>
    ''' <param name="arg2">А этот аргумент для того, чтобы...</param>
    ''' <returns></returns>
    ''' <remarks></remarks>
    Private Function MyFunction(ByVal arg1 As String, ByVal arg2 As Integer) As Integer
 
    End Function

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

@kritjara · 26.02.2019, 12:53 **[ТС]**

огромное спасибо за направление, буду пробовать

Добавлено через 31 минуту
Отлично все работает, то что мне нужно было.
И еще... не могли бы ли вы ответить что значат 2 последние строки комментрия

VB.NET
1
2
    ''' <returns></returns>
    ''' <remarks></remarks>

@Yury Komar · 26.02.2019, 13:10

kritjara, в Returns укажите что возвращает ваща функция.
в Remarks пишите примечание к функции.

Новые блоги и статьи Все статьи Все блоги /
PhpStorm 2025.3: WSL Terminal всегда стартует в ~ and_y87 14.12.2025 PhpStorm 2025. 3: WSL Terminal всегда стартует в ~ (home), игнорируя директорию проекта Симптом: После обновления до PhpStorm 2025. 3 встроенный терминал WSL открывается в домашней директории. . .	Access VikBal 11.12.2025 Помогите пожалуйста !! Как объединить 2 одинаковые БД Access с разными данными.	Новый ноутбук volvo 07.12.2025 Всем привет. По скидке в "черную пятницу" взял себе новый ноутбук Lenovo ThinkBook 16 G7 на Амазоне: Ryzen 5 7533HS 64 Gb DDR5 1Tb NVMe 16" Full HD Display Win11 Pro	Музыка, написанная Искусственным Интеллектом volvo 04.12.2025 Всем привет. Некоторое время назад меня заинтересовало, что уже умеет ИИ в плане написания музыки для песен, и, собственно, исполнения этих самых песен. Стихов у нас много, уже вышли 4 книги, еще 3. . .	От async/await к виртуальным потокам в Python IndentationError 23.11.2025 Армин Ронахер поставил под сомнение async/ await. Создатель Flask заявляет: цветные функции - провал, виртуальные потоки - решение. Не threading-динозавры, а новое поколение лёгких потоков. Откат?. . .
Поиск "дружественных имён" СОМ портов Argus19 22.11.2025 Поиск "дружественных имён" СОМ портов На странице: https:/ / norseev. ru/ 2018/ 01/ 04/ comportlist_windows/ нашёл схожую тему. Там приведён код на С++, который показывает только имена СОМ портов, типа,. . .	Сколько Государство потратило денег на меня, обеспечивая инсулином. Programma_Boinc 20.11.2025 Сколько Государство потратило денег на меня, обеспечивая инсулином. Вот решила сделать интересный приблизительный подсчет, сколько государство потратило на меня денег на покупку инсулинов. . . .	Ломающие изменения в C#.NStar Alpha Etyuhibosecyu 20.11.2025 Уже можно не только тестировать, но и пользоваться C#. NStar - писать оконные приложения, содержащие надписи, кнопки, текстовые поля и даже изображения, например, моя игра "Три в ряд" написана на этом. . .	Мысли в слух kumehtar 18.11.2025 Кстати, совсем недавно имел разговор на тему медитаций с людьми. И обнаружил, что они вообще не понимают что такое медитация и зачем она нужна. Самые базовые вещи. Для них это - когда просто люди. . .	Создание Single Page Application на фреймах krapotkin 16.11.2025 Статья исключительно для начинающих. Подходы оригинальностью не блещут. В век Веб все очень привыкли к дизайну Single-Page-Application . Быстренько разберем подход "на фреймах". Мы делаем одну. . .

@kritjara 70 / 60 / 16 Регистрация: 22.10.2012 Сообщений: 351

	Как создать описания для процедур и функций для собственного класса? 25.02.2019, 23:17. Показов 2027. Ответов 4 Метки нет (Все метки) В Visual Studio для всех процедур и функций различный классов созданы описания, т.е. кратко рассказывается что выполняет выбранная процедура или функция. Как создать такие же описания для своих классов? 0

Someone007 6691 / 4102 / 1607 Регистрация: 09.05.2015 Сообщений: 9,569
	25.02.2019, 23:20
	Documenting your code with XML comments 1

@Yury Komar Модератор 4356 / 3426 / 512 Регистрация: 27.01.2014 Сообщений: 6,257
	26.02.2019, 13:10
	kritjara, в Returns укажите что возвращает ваща функция. в Remarks пишите примечание к функции. 0

Как создать описания для процедур и функций для собственного класса?

Решение