类文档建议
本文关键字：文档 | 更新日期: 2023-09-27 18:16:13
我们是一个微软的商店，专注于使用c#。我们有几个项目，包括网站、Windows服务和类库，都合并了XML注释。
我希望为每个项目生成msdn风格的HTML文档，并将其部署到所有开发人员都可以轻松访问的集中位置。我还希望自动化这些步骤，以便它们可以定期运行，这样我和其他开发人员就不必担心在进行更改时要记住生成和部署新的文档。我看过Sandcastle和Doxygen，它们看起来都是生成我想要的文档的好选择，但我需要关于自动化生成文档的好方法的建议，比如在夜间工作或其他地方。
有人在做这样的事吗?我不相信最终的结果是HTML;尤其是如果有更好的主意。 编辑:我感谢所有的好主意。现在我可以研究几条路线，但在我亲自动手之前，我不知道哪条最有效。Sandcastle帮助文件生成器似乎为我提供了最好的选择，所以我同意这个建议。但是，如果我有更多的时间来研究XSLT和CSS解决方案，以使XML数据看起来恰到好处，我会首先遵循这个建议。再次感谢大家!
看看Sandcastle帮助文件生成器。它使用独立的项目，因此您可以随时构建它们(例如每晚构建，或者在每次签入更改时作为持续集成系统的一部分)。
您不需要任何第三方工具来生成漂亮的文档:c#编译器可以从XML注释中输出XML文档，您所需要的只是设计一个漂亮的CSS以在浏览器中显示它。如果不满意，还可以在应用CSS之前生成自己的xslt转换，如下所述(在注释中查找CSS示例!)。
或者，您可以使用NDoc之类的东西来改进这个XML文档。这里有一篇关于如何做到这一点的好文章，不幸的是有点过时了。
您可以通过使用/doc:documentationfilename.xml参数运行编译器，手动将项目的文档仅构建为单个XML文件。
您还可以在Visual Studio(项目属性->文档)中指示将此选项添加到项目的每次构建中，以便每次构建项目时都会生成XML文件。然后可以挂钩构建后事件，将XML文件复制到存储库中。
你也可以在你的Team Foundation Server上设置你的MS Build来构建你的文档，并以类似的方式(/p:DocumentationFile=fileName.xml)将其复制到存储库;
我就是这么做的。基本上，我们使用doxywizard来设置配置Doxyfile，它将为生成的html设置规范。然后，在构建服务器步骤中，我调用" xygen doxyfile"。
我们的Doxyfile被配置为在从我们的web服务器可见的区域生成氧文件。因此，每次提交到主干都会导致文档自动重建。