方法main的XML注释

本文关键字：注释 XML main 方法 | 更新日期: 2023-09-27 18:23:40

在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方法有什么建议的评论方式？

方法main的XML注释

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

我可能建议的唯一一个棘手的答案是，如果你想发表评论，只需使用双引号//而不是三元组。三元组被处理成类的文档，可能会导致后台问题。

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

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

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

希望能有所帮助。

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

相关文章：