有没有办法从我的C#文档注释中为github生成文档wiki？
有没有办法从我的C#文档注释中为github生成文档wiki？
提问于 2012-06-28 21:49:02
我想在Github上为我的开源项目生成API文档。我想从我的C#项目中的XML文档注释中自动创建它们。我虚弱的谷歌搜索找到了泡泡。有没有办法做到这一点？
我更希望它是Github风格的Markdown。
回答 3
Stack Overflow用户
回答已采纳
发布于 2012-07-14 04:17:13
我最终使用Sandcastle来生成普通的超文本标记语言，并使用它。不可避免的是，我将只为Sandcastle编写自己的解析器或自定义模板。
我不喜欢didn或QDoc的学习曲线。
Stack Overflow用户
发布于 2014-07-11 14:40:02
在搜索了一下之后，我发现了这个要点：
Generates Markdown from VS XML documentation file
它打印到控制台的C# XML ->标记。我相信它可以进一步完善，但这是一个非常好的开始。我测试过了，它完全起作用了。
Stack Overflow用户
发布于 2012-07-13 16:27:34
我推荐Doxygen。通过使用配置文件和XSLT配置Doxygen，您几乎可以使用它做任何事情。http://www.doxygen.nl/
在配置文件中设置源文件和输出，然后使用XSLT定制输出。
对于C#，已经准备好了一个解析器工具(http://code.google.com/p/doxygenxmlparser/)来完成大部分工作
如果(youDoNotLikeThisIdea == true)，另一个高度可配置的工具将是QDoc ( Qt的一部分)@ http://qt-project.org。当然，使用QDoc特别需要构建Qt和QDoc。
祝好运!
页面原文内容由Stack Overflow提供。腾讯云小微IT领域专用引擎提供翻译支持
原文链接：
https://stackoverflow.com/questions/11246126
复制相关文章
相似问题