如何在 C# 中为方法添加 (IntelliSense) 参数注释

Question

当我使用任何 .NET 方法时，都会有一个小提示（IntelliSense）来解释这些方法及其参数。

如何为我自己的方法实现相同的行为？

Visual Studio 是否有允许我添加这些的功能？

Answer 1

“功能”称为 XML 注释。只需在方法之前输入 /// ，VS 就会生成一些 xml 标签。这些将用于显示工具提示以及参数信息。

/// <summary>
/// this will be the tooltip
/// </summary>
/// <param name="args">args will be passed when starting this program</param>
static void Main(string[] args)
{

}

我的VS2010调用方法add时的屏幕截图。如您所见，显示了 xml 注释。

Answer 2

是的，你可以。这是一个例子：

/// <summary>
/// My super method
/// </summary>
/// <param name="myNumber">My number parameter</param>
/// <returns>My result</returns>
private int myMethod(int myNumber)
{
   return myNumber
}

要自动生成 xml 注释，只需在方法、属性、类等上方键入

///

。here 是推荐的文档标签。您还可以使用 GhostDoc 来简化您的文档职责。

Answer 3

它称为 XML 文档。您必须在方法签名上方写下以下注释：

/// <summary>
/// Performs a custom action: ...
/// </summary>
/// <param name="x">
/// An integer representing the ...
/// </param>
/// <param name="y">
/// A boolean representing the ...
/// </param>
public void MyMethod(int x, bool y) {
    //...
}

Answer 4

你需要这样的 xml 注释

///<summary>my Description</summary>
public void mymethod()

就像msdn上描述的那样 http://msdn.microsoft.com/en-us/library/b2s063f7(v=VS.100).aspx

Answer 5

您可以在函数中添加特殊注释（注意 3 个斜杠）这是一个简短的示例：

 /// <summary>
 /// This is my special function
 /// </summary>
 /// <param name="myParameter">Very important parameter.</param>
 /// <returns>Always returns 42.</returns>
 public int MyFunction(string myParameter)
 {
       return 42;
 }

说明： << summary >> 是用于解释功能的标签

<< param name="" >> 解释一个参数

<< returns >> 返回值解释的标签。

还有其他几个标签，当您编辑该评论时，Visual Studio 会向您显示这些标签。

Answer 6

如果您在方法/属性上方按正斜杠三次，Visual Studio 将生成一个 XML 注释摘要，然后您可以使用相关信息填充该摘要。

另一个好的提示是，如果您转到项目属性，然后转到“构建”选项卡，您将在底部看到“输出”部分。如果您每次构建项目时都勾选 XML 文档文件，您的 API 的 XML 文件将与 dll 一起生成，这对于使用您的 API 的其他开发人员来说非常有用。这也意味着 Visual Studio 将对任何尚未发表评论或评论错误的公众成员发出警告。

Answer 7

是的，你可以。这是 Xml 文档 参见此处