我想在 Github 上为我的开源项目生成 API 文档。我想从我的 C# 项目中的 XML 文档注释中自动创建它们。我微弱的谷歌搜索出现了 bubkiss。有没有办法做到这一点？
我更喜欢它是 Github 风格的Markdown。
问问题
6377 次
4 回答
8
这是一个在线C# XML 文档到 Markdown 转换器：http: //varus.io/vsdoc-2-md/
它基于@formixian 的算法。
于 2016-05-25T17:10:41.207 回答
7
在搜索了一下之后，我发现了这个要点：
它打印到 C# XML -> markdown 到控制台。我相信它可以进一步完善，但这是一个非常好的开始。我已经测试过了，它完全可以工作。
于 2014-07-11T06:40:01.877 回答
5
我最终使用Sandcastle生成纯 HTML 并使用它。不可避免地，我只会为 Sandcastle 编写自己的解析器或自定义模板。
我不喜欢 Doxygen 或 QDoc 的学习曲线。
于 2012-07-13T20:17:13.097 回答
3
我会推荐 Doxygen。通过使用配置文件和 XSLT 配置 Doxygen，您几乎可以用它做任何事情。http://www.doxygen.nl/
在配置文件中设置源文件和输出，然后使用 XSLT 自定义输出。
对于 Doxygen，有一个解析器工具 ( http://code.google.com/p/doxygenxmlparser/ ) 已经准备好使用 C# 完成大部分工作
if(youDoNotLikeThisIdea == true) 另一个高度可配置的工具是 QDoc（Qt API 的一部分）@ http://qt-project.org。当然，使用 QDoc 将需要您特别构建 Qt 和 QDoc。
祝你好运！
于 2012-07-13T08:27:33.867 回答