Как получить intellisense для пользовательских классов? - PullRequest
Новая
       12

Как получить intellisense для пользовательских классов?

11 голосов
/ 23 ноября 2011

Когда вы печатаете «это». вы обычно получаете все подпрограммы, события и многое другое ... текущего класса, в котором вы находитесь. А когда вы просто стоите над одной из подпрограмм в длинном списке, не выбирая одну, вы обычно получаете описание рядом с ней.

Как я могу это сделать? Предположим, у меня есть класс CAR с двумя подпрограммами: speed_up () и brake (). Как я могу заставить человека, использующего мой класс, видеть описание двух функций, когда он печатает: 

CAR mycar = new CAR();
mycar.

Ответы [ 7 ]

24 голосов
/ 23 ноября 2011

Над классом или методом, а не комментарием "//". если вы делаете тройную косую черту "///" (иначе называемую XML-комментарием), она выполняет кратчайший путь, чтобы вы могли заполнить информацию о классе или методе, который вы комментируете.

Это появляется в вашем коде как таковое 

    /// <summary>
    /// 
    /// </summary>
    /// <param name="sender"></param>
    /// <param name="e"></param>
    void Method(object sender, EventArgs e)

Когда вы затем обращаетесь к классу или методу через intellisense, вот когда появится описание.

8 голосов
/ 23 ноября 2011

Дайте вашим классам и их членам XML-комментарии , которые появятся в intellisense .Самый простой способ сделать это в visual studio - набрать /// над тем, к чему вы хотите добавить комментарии.

Например: 

/// <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)?

3 голосов
/ 23 ноября 2011

Вы должны использовать формат документации XML, доступный в Visual studio, для каждого типа конструкции (т. Е. Класса, методов, свойств ...)

Чтобы получить к нему доступ, введите /// в строке перед объявлением.

Например: 

  ///
  public void Method(string p){...

вы получите что-то вроде: 

  /// <summary>
  /// 
  /// </summary>
  /// <param name="p"></param>
  public void Method(string p){...

, если вы наберете /// <, вы даже получите список доступных элементов XML, например, замечания или примеры. Для получения дополнительной информации см. <a href="http://msdn.microsoft.com/en-us/magazine/cc302121.aspx" rel="nofollow">http://msdn.microsoft.com/en-us/magazine/cc302121.aspx

2 голосов
/ 23 ноября 2011

Вы должны оставить комментарий так: 

/// <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, когда вы напишите свой комментарий после трех \.

2 голосов
/ 23 ноября 2011

Вы можете оставлять комментарии так: 

/// <summary>
/// This sppeds up the car
/// </summary>
public void speed_up()
{ }
2 голосов
/ 23 ноября 2011

Попробуйте добавить сводку к вашим методам, введя /// и заполните, как показано ниже 

/// <summary>
/// This is my speed up method
/// </summary>
public void speed_up(){ ...}

, вы можете сделать это для каждого из методов и свойств, чтобы оно содержательно отображало намерение вIntellisense.

1 голос
/ 23 ноября 2011

Вам необходимо добавить комментарии к документам для методов. Вы можете сделать это вручную, набрав «///» или используя Visual Studio Addin. Если вы будете следовать правилам именования GhostDoc добавление поможет вам в этом.

...