沙堡还是NDoc?一个好的msdn式doc生成器?

时间:2010-12-18 20:50:44

标签: msdn documentation-generation

我一直在困扰自己一个问题:“Javadoc,Doxygen等等......微软真的有可能不为它的开发人员提供一个好的文档生成器吗?”它总是听起来很奇怪...也因为Msdn是一个非常好的文档排版...我真的更喜欢它高于所有其他生成器和文档样式。

继续打扰自己我最终决定深入研究这个问题,发现NDoc和SandCastle的存在。哇,我告诉自己,我终于明白了......所以看起来如此。好吧,他们是好的发电机,但我认为微软赞助的官方文档比我之前提到的那两个更多。

那么,我想要什么?只知道微软开发人员使用什么doc-gen来记录他的msdn类风格的代码。 是NDoc还是Sand Castle官方的msdn-like文件生成器,批准了我的微软? 哪一个是最好的? 如果不是,我应该用什么doc-gen来用msdn-style记录?

3 个答案:

答案 0 :(得分:2)

我们使用DocumentX(用于使用NDoc),我非常喜欢它。他们的许可证检查系统有点痛苦,但程序本身很棒。

答案 1 :(得分:1)

SandCastle(使用GUI)是完全充足的文档生成器。我没有看到MS为此付出更多努力的原因。

顺便说一下,您可能希望获得GhostDoc Visual Studio插件。它可以大大加快文档注释的创建速度(它甚至可以完全生成它们,只要您正确命名方法和参数以及填充内容)。

答案 2 :(得分:1)

尽管最初的NDoc项目在几年前停止了,但仍有一个后续项目:NDoc3