Question

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

我该怎么做？假设我有一个名为CAR的类，它有两个例程：speed_up（）和brake（）。当他输入时，我怎样才能让使用我的班级的人看到这两个函数的描述：

CAR mycar = new CAR();
mycar.

Answer 1

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

然后会出现在您的代码中

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

然后，当您出现描述时，通过intellisense访问类或方法。

Answer 2

将您的课程及其成员XML comments提供给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)
    {
    }
}

以上内容被发现here。

另请参阅：How do you get XML comments to appear in a different project (dll)?

Answer 3

您应该使用Visual Studio中可用的XML文档格式来处理每种类型的构造（即类，方法，属性......）

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

例如：

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

你会得到类似的东西：

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

如果输入///＆lt;您甚至可以获得可用XML元素的列表，例如备注或示例有关更多信息，请参阅http://msdn.microsoft.com/en-us/magazine/cc302121.aspx

Answer 4

通过键入///并填写如下

，尝试向您的方法添加摘要

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

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

Answer 5

您可以添加以下评论：

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

Answer 6

你必须像这样发表评论：

/// <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会列出这些标签。

Answer 7

您需要为方法添加文档注释。您可以通过键入“///”或使用visual studio addin手动完成此操作。如果您遵循良好的命名约定GhostDoc，添加将帮助您解决此问题。

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

7 个答案: