c# - 如何为 C# 生成文档，输出为 Azure DevOps Wiki 的 Markdown？

Question

我一直在使用 DocFX 为 C# 生成代码文档，并且在大多数情况下都取得了很大的成功。这些文章很灵活，我真的很喜欢我可以使用 Markdown 来维护它们，同时让它们与 API 参考并存。我还花时间在 Markdown 中记录演练并构建 CI 管道。

我要解决的问题是我需要想办法让我的代码文档（xml 注释）输出为 markdown 而不是 html，以便它可以由 markdown wiki 解决方案托管，特别是 Azure DevOps（又名 TFS） . Azure DevOps Wiki 似乎也与来自 GitHub 的 gh-pages 非常相似，因此我对可能能够在 Azure DevOps 中工作的类似解决方案感兴趣。DocFX 没有解决这个问题，因为输出是 .html 而不是 markdown。

Microsoft 的所有文档都专注于手工编写文档。我有兴趣根据代码中的 xml 注释生成文档。

标签： c#azure-devopsmarkdowndocumentationdocfx

Answer 1

它看起来像是对DocFx的长期开放请求。

在我看到XmlDocMarkdown的几个地方推荐了这种替代解决方案。

从 .NET XML 文档注释生成 Markdown 的控制台应用程序。

或者你总是可以选择Pandoc。使用库存转换，或为转换过程滚动您自己的自定义 LUA 过滤器。