如何在.NET中使用内联注释来记录成员

Question

如何在.Net中内联记录成员？让我解释一下。大多数从注释中提取文档的工具都支持某种内联文档，您可以在成员声明后添加简短的内容。类似于：

public static string MyField; /// <summary>Information about MyField.</summary>

有没有一种方法可以在C#或.NET语言中做到这一点？

Answer 1

不，你不能。XML注释仅作为块级注释受支持，这意味着它必须放在要文档化的代码元素之前。从.NET代码中提取XML注释的常用工具不了解如何解析这样的内联注释。如果您需要这种能力，您将需要编写自己的解析器。

Answer 2

没有内置的方法可以做到这一点。XML文档系统是分层的；它定义了标签<summary />和紧随其后的数据之间的关系。

Answer 3

是的，把它放在你想评论的东西之前

/// <summary>Information about MyField.</summary>
public static string MyField;