我一直在使用 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 过滤器。
关于c# - 如何为 C# 生成输出为 Azure DevOps Wiki 的 Markdown 的文档?,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/60063974/