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

при вводе " this.", вы обычно получаете все процедуры, события и многое другое... текущего класса вы находитесь. И когда вы просто стоите над одной из процедур в длинном списке, не выбирая ее, вы обычно получаете описание рядом с ней.

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

CAR mycar = new CAR();
mycar.
10
c# intellisense visual-studio

7 ответов

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

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

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

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

23

дайте ваши классы и их членов, 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)?

8

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

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

например:

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

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

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

Если вы введете / / / http://msdn.microsoft.com/en-us/magazine/cc302121.aspx

3

вы можете поместить такие комментарии:

/// <summary>
/// This sppeds up the car
/// </summary>
public void speed_up()
{ }
2

вы должны поставить комментарий к нему следующим образом:

/// <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>. Некоторые теги mor поддерживаются, они будут перечислены visual studio, когда вы напишете свой комментарий после трех \.

2

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

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

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

2

вам нужно добавить комментарии к документу для методов. это можно сделать вручную, введя "/ / / " или с помощью Visual studio addin. Если вы следуете хорошим соглашениям об именах GhostDoc добавление поможет вам много на этом.

1