Отправляет email-рассылки с помощью сервиса Sendsay

[TC] Visual studio: озвучиваемые Джозом подсказки для аргументов методов

Всем привет. Когда используешь встроенные в .net методы, то при вводе
левой скобки Джоз озвучивает подсказку по аргументам этого метода, ну,
например, для метода Show() у MessageBox мы услышим для первого
аргумента "Text: The text to display in the message box", для второго
услышим другой текст, для третьего - третий. Научите, пожалуйста, как
пишутся эти подсказки. Хотелось бы сделать нечто похожее для собственных
методов.

Ответить   Fri, 11 Oct 2019 19:21:35 +0300 (#3633252)

 

Ответы:

Вводите три наклонные черты как для комментария, дальше само сгенерируется.
Редактируете <param>тут</param> для ваших аргументов.

А.

Ответить   Fri, 11 Oct 2019 19:51:03 +0300 (#3633257)

 

Здравствуйте, ЯСЯ.

Это делается через комментарии XML.
По-моему достаточно просто перед объявлением метода добавить ///, и VS сама
допишет туда шаблонные XML-комментарии с описанием метода и его параметров.
В любом случае, выглядит примерно так:

/// <summary>
/// this will be the tooltip
/// </summary>
/// <param name="args">args will be passed when starting this
program</param>
static void Main(string[] args)
{
}

Успехов. Никита.

Ответить   Fri, 11 Oct 2019 21:35:45 +0300 (#3633269)

 

Здравствуйте, Яся.

Это реализуется с помощью специальных xml комментариев:

https://docs.microsoft.com/ru-ru/dotnet/csharp/codedoc

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

К примеру, тег <summary> используется для общего описания сущьности, а
тег <returns> для описания возвращаемого результата.

Можно ввести три слэша "///" над сущьностью, которую нужно описать и
студия сама с генерирует готовый шаблон с уже поименованными
параметрами, если они есть.

С уважением, Константин.

Ответить   Fri, 11 Oct 2019 21:56:52 +0300 (#3633272)