c# - 如何在 .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;