2

我是开发新手，想问一个非常基本的问题，我正在查看 C# 中的一些代码并尝试重现应用程序当我遇到带有三个斜杠的 param 标记时，我不知道该怎么做，请查看以下示例： -

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

两个和三个斜杠用于评论，所以这是评论还是我需要删除评论并按照描述放置值。

提前致谢..

4

3 回答 3

1

它用于记录代码。

从上面的链接：

'param' 标签定义每个参数

在您的示例中，文档描述了可以传递给requestMethod. 在没有看到方法签名的情况下，很难确定这些值是否是 strings GET、PUT或DELETE可能是 C# 枚举值。

另请参阅MSDN的文章

于 2012-05-02T10:23:43.573 回答
1

三个斜杠///是 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

}

因此，当调用此方法时，您将执行以下操作：

做某事(999)

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

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

于 2012-05-02T10:26:09.770 回答
0

这只是一种特殊的评论。

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

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

请参阅 Microsoft 的建议：

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

于 2012-05-02T10:22:52.193 回答