c# - 我可以从 XML 文档生成 .MD 文件吗？

Question

我最近使用 SandcaSTLe 来记录我的类库。但是，我最近发现 SandcaSTLe 不再由 Microsoft 开发:https://archive.codeplex.com/?p=sandcastle .

我在 GitHub 上在线查看过，我发现现在很多开源项目都使用 .MD (MarkDown) 文件。我看到 .MD 文件受 GitHub 和 TFS 支持。如何从 XML 文档文件生成 .MD 文件？

我花了最后几个小时在谷歌上搜索这个。例如，我只下载了几百次就发现了这个:https://github.com/lijunle/Vsxmd/tree/master/Vsxmd我不是在寻求工具建议。我在问是否可以将 .XML 文档转换为 .MD 文件。

Answer 1

对的，这是可能的。

有许多项目可以这样做。您找到的那个 Vsxmd例如，还有更简单的，比如 lontivero/593fc51f1208555112e0 .

该过程基本上是读取每个 XML 元素(或其中一些)并将其转换为 Markdown 中的等效元素。等效项是您在编写转换器时必须选择的内容，这取决于您想要的结果文件的样式。

处理诸如 <inheritdoc/> 之类的标签时，事情会变得复杂起来。如果您不想只打印“从父级继承”。像 Vsxmd 那样或像 lontivero 那样忽略它。

我仍在寻找更好的工具或改进工具的时间。