班级文档建议

Question

我们是一家Microsoft商店，专注于使用C＃。我们有几个项目，包括网站，Windows服务和类库，其中包含XML评论。

我希望为每个项目生成MSDN风格的HTML文档，并将其部署到所有开发人员都可以轻松访问的集中位置。我还想自动执行这些步骤，以便可以定期运行它们，因此我和其他开发人员无需担心记住每当进行更改时生成和部署新文档。我已经看了Sandcastle和Doxygen，两者看起来都是生成我想要的文档的好选择，但是我需要一种很好的建议来自动化它的一代，例如在每晚工作中。

那里有人在做这样的事情吗？我没有在最终结果上出售HTML；特别是如果有一个更好的主意。

编辑：

我感谢所有的好主意。现在有几条路线可以进行调查，但是直到我弄脏手之前，我不知道哪个路线最佳。 Sandcastle帮助文件构建器似乎为我提供了我想要做的事情的最佳选择，因此我会向我致敬。但是，如果我有更多时间在XSLT和CSS解决方案上工作以使XML数据看起来正确，我将首先提出该建议。

再次感谢大家！

Answer 1

看一眼 Sandcastle帮助文件构建器. 。这使用独立的项目，因此您可以按照自己的方式进行尽可能多的构建（例如，每晚或作为您的一部分 持续集成 每次签入更改时系统）。

Answer 2

您不需要任何第三方工具来生成不错的文档：C＃编译器可以从XML中的XML-Comments输出文档，而您所需的只是设计一个不错的CSS以在浏览器中显示。如果您不满意，也可以在应用CSS之前生成自己的XSLT-TransoFormation， 如下所述 （在评论中查找CSS的示例！）。

或者，您可以使用此XML文档并使用类似的内容进行改进 ndoc. 。这里有一个 不错的文章 关于如何做，不幸的是，有些过时了。

您可以通过运行编译器，将项目的文档手动构建到单个XML文件中 /doc:documentationfilename.xml 范围。

您还可以在Visual Studio（Project Properties - >文档）中指示将此选项添加到项目的每个构建中，以便每次构建项目时都会生成XML文件。然后，您可以将后构建事件挂钩以将XML文件复制到您的存储库。

您还可以在团队基础服务器上设置MS构建以构建文档并以类似的方式将其复制到存储库（/p:DocumentationFile=fileName.xml);

Answer 3

我在我们的项目中做到这一点。基本上，我们使用doxywizard来设置配置doxyfile，该配置将设置生成的HTML的规格。然后，在构建服务器步骤中，我调用“ doxygen doxyfile”。

我们的doxyfile配置为从我们的Web服务器可见的区域中生成doxygen文件。因此，每个承诺都会导致文档自动重建文档。