如何在c＃中为方法添加参数注释

Question

当我使用任何.NET方法时，会有一些提示解释方法及其参数。

如何为自己的方法实现相同的行为？ 是否有Visual Studio功能允许我添加这些功能？

Answer 1

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

/// <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的屏幕截图。 如您所见，显示了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注释，只需在方法，属性，类等上方键入/// 。 这里是文档的推荐标记。 您也可以使用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 =“”>>解释一个paremter

<< returns >>用于解释retunr值的标记。

当您编辑该注释时，Visual Studio将向您显示更多标记。

Answer 6

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

另一个好的建议是，如果你去项目属性，然后是Build选项卡，你会看到底部有输出部分。 如果您在每次构建项目时都勾选XML文档文件，那么将在dll旁边生成API的XML文件，这对于使用API​​的其他开发人员来说非常有用。 这也意味着visual studio将针对尚未评论或评论错误的任何公共成员发出警告。

Answer 7

是的你可以。 这是Xml文档， 请看这里