我该如何为C#生成文档，以Markdown格式输出到Azure DevOps Wiki？

Question

我该如何为C#生成文档，以Markdown格式输出到Azure DevOps Wiki？

c#azure-devopsmarkdowndocumentationdocfx

14

我一直在使用DocFX为C＃生成代码文档，并且大部分时间都非常成功。文章很灵活，我真的很喜欢可以使用markdown来维护它们，同时与API参考并排而存的功能。我已经花费了时间用Markdown记录演练并构建CI管道。

我试图解决的问题是：我需要找到一种将我的代码文档（XML注释）输出为markdown的方法，以便可以通过markdown wiki方案进行托管，特别是Azure DevOps（又名TFS）。 Azure DevOps Wiki似乎与GitHub的gh-pages非常相似，因此我对可能能在Azure DevOps中运作的类似解决方案感兴趣。DocFX无法解决此问题，因为输出是.html而不是markdown。

所有Microsoft的文档都集中在手写文档上。我对基于代码中xml注释生成文档感兴趣。

- War Gravy

@LeoLiu-MSFT，我找到的最相关的工具是被接受的答案。最终我使用了VSXMD和一个PowerShell脚本将所有Markdown文件合并到一个文件夹中。 - War Gravy

1个回答

网页内容由stack overflow 提供, 点击上面的

可以查看英文原文，
原文链接

- Eric Smith · Accepted Answer

看起来在 DocFx 上存在一个长期的未解决的请求。

在我看到的一些地方，推荐使用 XmlDocMarkdown 这个替代方案。

引用如下：

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

或者您也可以选择使用 Pandoc，使用默认转换或为转换过程自定义 LUA 过滤器。