主要方法的 XML 注释？答案

【问题标题】：XML comment for method main?主要方法的 XML 注释？
【发布时间】：2013-07-17 05:32:11
【问题描述】：

在 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

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

【问题讨论】：

它在 VS2008 和 VS 2010 中对我来说工作正常，0 错误 0 警告和 0 消息！你在哪里收到这条消息：XML comment is not placed on a valid language element main
某些语言元素并没有大声地拥有诸如命名空间之类的 xml 文档，显然在这种情况下主要方法也是如此。 msdn.microsoft.com/en-us/library/d3x6ez1z(v=vs.90).aspx 我建议如果你想评论它只需使用双引号 //
@SanjeevRai：错误出现在 Visual Studio 2010 Professional 的Error list 窗口中。
@AMR：您能否提出这个作为答案？这可能就是我最终会做的事情。
我猜应该是警告错误。

【解决方案1】：

我认为您还需要为参数放置 cmets。

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

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

希望对你有帮助。

【讨论】：

【解决方案2】：

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

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

【讨论】：

【解决方案3】：

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

【讨论】：