c# - 主要方法的 XML 注释？

Question

在 C# 中，我为该main方法编写了 XML 注释：

/// <summary>
/// Some comment.
/// </summary>
public static void Main(string[] args)
{

但是 Visual Studio 警告我不要这样做：

XML comment is not placed on a valid language element main

main在 C#中评论方法的推荐方法是什么？

Answer 1

我认为您还需要为参数添加注释。

/// <summary>
/// 
/// </summary>
/// <param name="args"></param>
static void Main(string[] args)
{

我认为这就是 VS 正在寻找的。写好方法后，只需///在方法上方输入即可。至少它在我的 Visual Studio 中没有给出错误/警告。

希望能帮助到你。

Answer 2

某些语言元素不允许有 xml 文档，例如命名空间，显然在这种情况下也有 main 方法。文档说明了这一点，并且还有一些链接显示了其他 XML 的注意事项。

我可能建议的唯一 hacky 答案是，如果您想评论它，只需使用双引号 // 而不是三元组。三元组被处理成类的文档，可能会导致背景问题。

Answer 3

我想给它添加一个建议。转到项目的属性 -> 构建，然后在开始编写 XML 文档之前标记说明 XML 文档文件的复选框。这将在您编写 XML 标记时为您提供帮助。如果你放置了一个无效的 XML 标签，比如上面的命名空间，那么 VS 会提示说：XML 注释没有放在有效的语言元素上。