有没有办法从我在C#中的XML文档注释中为github生成文档wiki？

Question

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

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

Answer 1

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

它基于@ formixian的算法.

Answer 2

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

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

我做了一个实现更好的结果:https://gist.github.com/formix/515d3d11ee7c1c252f92生成的文档如下所示:https://github.com/formix/MegaCityOne/blob/master/MegaCityOne/doc/api .MD (3认同)

Answer 3

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

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