Как добавить комментарии к параметрам для метода в С#

Ответ 1

"функция" называется комментариями XML. Просто введите///прямо перед вашими методами и VS создаст некоторые теги xml. Они будут использоваться для отображения всплывающей подсказки, а также информации о параметрах aso.

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

}

Снимок экрана моего VS2010 при вызове метода add. Как вы можете видеть, отображаются комментарии xml.

Ответ 2

Да, вы можете. Вот пример:

/// <summary>
/// My super method
/// </summary>
/// <param name="myNumber">My number parameter</param>
/// <returns>My result</returns>
private int myMethod(int myNumber)
{
   return myNumber
}

Чтобы автоматически генерировать комментарий xml, просто введите /// над вашим методом, свойством, классом и т.д. И здесь рекомендуются теги для документации. Также вы можете использовать GhostDoc, чтобы упростить вашу документацию.

Ответ 3

Он называется XML-документация. Вы должны написать следующие комментарии над вашей сигнатурой метода:

/// <summary>
/// Performs a custom action: ...
/// </summary>
/// <param name="x">
/// An integer representing the ...
/// </param>
/// <param name="y">
/// A boolean representing the ...
/// </param>
public void MyMethod(int x, bool y) {
    //...
}

Ответ 4

Вам нужны комментарии xml, подобные этому

///<summary>my Description</summary>
public void mymethod()

Как описано в msdn http://msdn.microsoft.com/en-us/library/b2s063f7(v=VS.100).aspx

Ответ 5

Вы можете сделать заливку, добавив специальный комментарий к вашей функции (Mind the 3 slashes). Вот краткий пример:

 /// <summary>
 /// This is my special function
 /// </summary>
 /// <param name="myParameter">Very important parameter.</param>
 /// <returns>Always returns 42.</returns>
 public int MyFunction(string myParameter)
 {
       return 42;
 }

Объяснение: < < summary → Является тегом для объяснения функциональности

< < param name= "" → Объясняет один paremter

< < return → Тег для объяснения значения retunr.

Есть еще несколько тегов, whoch Visual Studio покажет вам, когда вы отредактируете этот комментарий.

Ответ 6

Да, вы можете. Документация Xml см. Здесь

Ответ 7

Если вы нажимаете косую черту три раза, когда над вашей визуальной студией method/property будет генерироваться сводка комментариев XML, которую вы затем можете заполнить соответствующей информацией.

Другим хорошим советом является то, что если вы перейдете к свойствам проекта, а затем вкладку "Построение" вы увидите внизу, появится раздел "Выход". Если вы укажете файл документации XML каждый раз, когда будет создан ваш проект, XML файл для вашего API будет создан вместе с dll, который отлично подходит для других разработчиков, потребляющих ваш API. Это также означает, что визуальная студия будет вызывать предупреждения для любого публичного участника, который еще не комментирует или комментирует неправильно.