我如何为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。

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

或者您可以始终使用Pandoc。使用股票转换，或在转换过程中使用您自己的自定义Lua过滤器。

这篇关于我如何为C#生成文档，并将其作为Azure DevOps Wiki的Markdown输出？的文章就介绍到这了，希望我们推荐的答案对大家有所帮助，也希望大家多多支持IT屋！