方法主的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

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

Answer 1

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

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

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

希望它有所帮助。

Answer 2

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

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

Answer 3

我想补充一点建议。 转到项目的属性 - ＆gt;在开始编写XML文档之前，构建并标记表明XML文档文件的复选框。 这将在编写XML标记时帮助您。如果你放置一个无效的XML标签，比如上面的命名空间，那么VS会提示说明：XML注释没有放在有效的语言元素上。