Когда вы вводите "this"., вы обычно получаете все подпрограммы, события и т.д. текущего класса, в котором вы находитесь. И когда вы просто стоите над одной из подпрограмм в длинном списке, не выбирая его, вы обычно получаете описание рядом с ним.
Как я могу это сделать? Предположим, что у меня есть класс CAR с двумя подпрограммами: speed_up() и brake(). Как я могу заставить человека, использующего мой класс, просмотреть описание двух функций, когда он набирает:
CAR mycar = new CAR();
mycar.
Выше класса или метода, а не комментария "//". если вы выполняете тройную косу "///" (иначе называемую комментарием XML), она выполняет короткое сокращение, чтобы вы могли заполнять информацию о классе или методе, который вы комментируете.
Это значит, что в вашем коде как таковой
/// <summary>
///
/// </summary>
/// <param name="sender"></param>
/// <param name="e"></param>
void Method(object sender, EventArgs e)
Когда вы затем получаете доступ к классу или методу с помощью intellisense, когда будет отображаться описание.
Дайте своим классам и их членам XML-комментарии, которые появятся в IntelliSense. Самый простой способ сделать это в визуальной студии - набрать /// над тем, что вы хотите добавить в комментарии.
Например:
/// <summary>
/// Class level summary documentation goes here.</summary>
/// <remarks>
/// Longer comments can be associated with a type or member through
/// the remarks tag.</remarks>
public class TestClass : TestInterface
{
/// <summary>
/// Store for the name property.</summary>
private string _name = null;
/// <summary>
/// The class constructor. </summary>
public TestClass() { }
/// <summary>
/// Description for SomeMethod.</summary>
/// <param name="s"> Parameter description for s goes here.</param>
/// <seealso cref="System.String">
/// You can use the cref attribute on any tag to reference a type or member
/// and the compiler will check that the reference exists. </seealso>
public void SomeMethod(string s)
{
}
}
Выше было найдено здесь.
См. также: Как вы можете получить комментарии XML в другом проекте (dll)?
Вы должны использовать формат документации XML, доступный в Visual Studio для каждого типа конструкций (например, класс, методы, свойства...)
Чтобы получить доступ к нему, введите///в строке перед объявлением.
Например:
///
public void Method(string p){...
вы получите что-то вроде:
/// <summary>
///
/// </summary>
/// <param name="p"></param>
public void Method(string p){...
если вы наберете /// < вы даже получите список доступных элементов XML, например примечания или примеры Для получения дополнительной информации см. http://msdn.microsoft.com/en-us/magazine/cc302121.aspx
Попробуйте добавить сводку к своим методам, введя /// и заполнив, как показано ниже
/// <summary>
/// This is my speed up method
/// </summary>
public void speed_up(){ ...}
вы можете сделать это для каждого из методов и свойств, чтобы он осмысленно отображал намерение в Intellisense.
Вы можете размещать комментарии следующим образом:
/// <summary>
/// This sppeds up the car
/// </summary>
public void speed_up()
{ }
Вы должны оставить комментарий на нем следующим образом:
/// <summary>
/// This is my function.
/// </summary>
/// <param name="myParameter">This parameter is very important.</param>
/// <returns>It returns always 42.</returns>
public int MyFunction(string myParameter)
{
return 42;
}
Вы можете описать использование функции <summary> и значение параметров <param name="">. Если функция имеет возвращаемое значение, вы можете описать ее с тегом <returns>. Есть некоторые поддерживаемые теги, которые будут отображаться в visual studio, когда вы напишете свой комментарий после трех \.
Вам нужно добавить комментарии к документам для этих методов. вы можете сделать это вручную, набрав '///' или используя visual studio addin. Если вы следуете хорошим соглашениям об именах GhostDoc добавление поможет вам в этом.