.net - 为什么 Roslyn 团队将 DocumentationComment 标记为内部

Question

我们正在尝试从 Roslyn 的 CTP 迁移到最新的 Roslyn 版本。但似乎他们更新了 DocumentationProvider 逻辑。在 CTP 中，它使用此提供程序返回的 DocumentationComment 类。此类具有用于解析这些属性的 xml 的有用逻辑

public string FullXmlFragmentOpt { get; private set; }

public string ExampleTextOpt { get; private set; }

public string SummaryTextOpt { get; private set; }

public string ReturnsTextOpt { get; private set; }

在新版本的Roslyn DocumentationComment类通过新属性进行了改进，但不知何故它被标记为内部。现在，DocumentationProvider 仅返回包含 XML 内容的完整字符串。由于 DocumentationComment 是一个内部类 - 我们不能使用它。

Roslyn 团队这样做有什么原因吗？或者也许他们会在下一个版本中将其归还？

Answer 1

DocumentationComment 类已从编译器层移出并成为内部类，因为它被认为不足以描述文档注释中的所有细节，因为它包含其他片段，例如 see 和 cref，并且实际上可以包含任何其他片段你想要的 xml 标签。作为公共(public) API 的一部分，唯一有意义的结构是 xml 字符串，您可以使用 xml 阅读器或 DOM 将其分开。现在，DocumentationComment 类是单个 Roslyn 功能的实现细节。

由于它是开源的，如果您愿意，可以通过复制代码来使用它。实际的内部类可能会发生变化，甚至可能被删除