无法理解参数标签的作用

本文关键字：标签 作用 参数 | 更新日期: 2023-09-27 18:33:06

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

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

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

提前谢谢..

无法理解参数标签的作用

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

它用于记录代码。

从上面的链接：

"参数"标签定义每个参数

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

另请参阅来自 MSDN 的文章

这只是一种特殊的评论。

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

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

请参阅微软的建议：

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

相关文章：