如何为自定义创建的类获取智能感知？

Question

当你输入“这个”时。 ，您通常会获得当前班级的所有例程、事件等。当您只是站在长列表中的一个例程而不选择其中一个时，您通常会在它旁边看到一个描述。

我怎样才能做到这一点？ 假设我有一个名为 CAR 的类，它有两个例程：speed_up() 和brake()。 如何让使用我的类的人在输入时看到这两个函数的描述：

CAR mycar = new CAR();
mycar.

Answer 1

为您的班级及其成员提供 XML 注释，这些注释将显示在智能感知。在 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) 中？

Answer 2

您应该对每个类型构造（即类、方法、属性...）使用 Visual Studio 中可用的 XML 文档格式。

要访问它，请在声明之前的行中键入 ///。

例如：

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

你会得到类似的信息：

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

如果你输入 ///<您甚至可以获得可用 XML 元素的列表，例如备注或示例
有关详细信息，请参阅 http://msdn.microsoft.com/en-us/杂志/cc302121.aspx

Answer 3

您可以这样发表评论：

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

Answer 4

你必须这样注释：

/// <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;
}

你可以描述函数

的用法以及参数的含义.如果函数有返回值，可以用标签来描述它。支持一些 mor 标签，当您在三个 \ 之后写下评论时，Visual Studio 会列出这些标签。

Answer 5

尝试通过键入 /// 向您的方法添加摘要，并像下面一样填写，

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

您可以对每个方法和属性执行此操作，以便它在 Intellisense 中有意义地显示意图。

Answer 6

您需要为方法添加文档注释。您可以通过键入“///”或使用 Visual Studio 插件手动执行此操作。如果您遵循良好的命名约定 GhostDoc 添加将对您有很大帮助。

Answer 7

在类或方法之上，而不是“//”注释。如果您使用“///”三斜杠（也称为 XML 注释），它会执行一个快捷方式，以允许您填写有关您正在注释的类或方法的信息。

然后，这会出现在您的代码中，

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

当您通过智能感知访问类或方法时，描述就会出现。