如何为 C# 生成输出为 Azure DevOps Wiki Markdown 的文档?

How can I generate documentation for C# that outputs as Markdown for an Azure DevOps Wiki?

我一直在使用 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 注释生成文档。

它看起来像是在 DocFx 上的一个长期开放请求。

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

A console app that generates Markdown from .NET XML documentation comments.

或者您总是可以选择 Pandoc。使用股票转换,或为转换过程推出您自己的自定义 LUA 过滤器。