有没有办法从我在C＃中的XML文档注释中为github生成文档wiki？ [关闭]

Question

我想在Github上为我的开源项目生成API文档。我想从我的C＃项目中的XML文档注释中自动创建它们。我的微弱的谷歌搜索出现了bubkiss。有没有办法做到这一点？

我更喜欢它是Github风格的Markdown。

Answer 1

在搜索了一下之后，我发现了这个要点的宝石：

Generates Markdown from VS XML documentation file

它打印到控制台的C＃XML - > markdown。我相信它可以进一步提炼，但这是一个非常好的开始。我测试了它，它完全正常工作。

Answer 2

这是Markdown转换器的在线C＃XML文档：http://varus.io/vsdoc-2-md/

它基于@ formixian的算法。

Answer 3

我最终使用Sandcastle生成纯HTML并使用它。不可避免地，我只会为Sandcastle编写自己的解析器或自定义模板。

我不喜欢Doxygen或QDoc的学习曲线。

Answer 4

我会推荐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。

祝好运！