Question

我是开发新手并且想问一个非常基本的问题，我在C＃中查找一些代码并尝试重现应用程序当我遇到带有三个斜杠的param标签时，我没有得到该怎么做，请查看下面的例子： -

/// <param name="requestMethod">one of GET, PUT, DELETE</param>

两个＆amp;三个斜杠用于注释，所以这是注释，或者我需要删除注释并按照描述放置值。

提前致谢..

Answer 1

适用于documenting code。

从上面链接：

'param'标签定义每个参数

在您的示例中，文档描述了可以传递到requestMethod的值。如果没有看到方法签名，则很难确定这些值是字符串GET，PUT和DELETE还是可能是C＃枚举值。

另见MSDN

中的文章

Answer 2

三个斜杠///是XML注释，而两个斜杠//只是代码中的标准注释。

因为你可以看到带有三个斜杠的XML注释有关于整个方法的信息，而方法主体中的//注释只是对该方法的一部分的注释。

/// <summary>
/// Does something.
/// </summary>
///<param name="param1">The parameter .</param>
public void doSomething(int param1)
{
     // This is a standard comment about some code

}

因此，在调用此方法时，您会这样做：

doSomething的（999）

行///<param name="param1">The parameter .</param>表示此方法希望您将某些内容作为参数传递

有关使用XML方法的详细信息，请参阅此处：http://msdn.microsoft.com/en-us/magazine/cc302121.aspx

Answer 3

这只是一种特殊的评论。

在Visual Studio中，如果按某方法上方的///，它将根据当前方法自动为您创建信息。

这用于文档，您可以让编译器使用/ doc命令行选项生成包含此信息的xml文件。

参见微软推荐：

http://msdn.microsoft.com/en-us/library/5ast78ax.aspx

无法理解param标签的作用

3 个答案: