Установите всплывающую справку функции для поддержки разведки в C #

Question

Как мы все видим в аналитической поддержке Visual Studios, все, что является частью кода, написанного Microsoft, имеет раздел сведений, который предоставляет информацию о функциях переменной, события, функции и т. Д., В качестве всплывающей подсказки.Где, поскольку написанные нами функции предоставляют только информацию об ожидаемых переменных, которые будут переданы.Может кто-нибудь, пожалуйста, помогите мне выяснить, как записать информацию в раздел подробностей для написанного пользователем кода?

Спасибо!

Answer 1

Я подозреваю, что вы ищете XML документация .Например:

/// <summary>This method does something funky.</summary>
public void Foo()
{
}

Введите /// чуть выше объявления метода, чтобы Visual Studio создала для вас скелет.Если вы хотите распространять документацию вместе с библиотекой, вам нужно включить генерацию XML в свойствах вашего проекта.Как правило, файл XML следует называть так же, как DLL, например, Acme.MyProject.dll будет иметь документацию в Acme.MyProject.xml.

Answer 2

Как: использовать функции документации XML

Answer 3

То, что вы ищете, это

///<summary>

прямо перед объявлением вашего метода попробуйте ввести "///", он должен начать процесс использования комментариев XML. Он автоматически покажет все параметры метода, а также возврат ...

Вы можете получить больше информации по адресу:

http://msdn.microsoft.com/en-us/magazine/cc302121.aspx