Windows runtime 将XML文档添加到WinRT项目的最简单方法 我们有一个从C++到C和WRT的开发人员。我们使用D'Office作为C++开发人员构建的一部分，我希望继续将文档生成作为C语言开发人员在C/Y/WRRT中的一部分。

打开XML文档生成很容易，我相信这将为格式错误的标记提供警告，但如果没有实际的HTML输出，我认为我们的开发人员将丢失有价值的反馈

看起来NDoc现在已经不存在了，我快速查看了Sandcastle，但发现它相当复杂。理想情况下，我正在寻找的东西不会给开发人员带来不必要的负担，也不会要求他们在编辑、构建、测试和提交时记住额外的步骤。换句话说，最好的解决方案应该是“碰巧发生”的事情，比如后期构建步骤，并且不会显著增加每个开发人员的构建时间

如果有人在C#/WinRT中有这样做的经验，我当然希望得到一些建议

提前谢谢

得到

在Visual Studio解决方案中为库创建帮助项目

从调试解决方案配置中删除Build复选标记，以便仅在版本配置中生成文档项目，因为调试在开发过程中最常用。对于版本构建测试或性能测试，您可以创建另一个解决方案配置，也可以简单地来回切换该选项

构建文档一次

将文档文件包括在解决方案中，以便在文件更改时显示在“挂起的更改”窗口中

请让您的开发人员在签入之前使用更新文档的版本配置进行构建，或者使用任何其他策略来要求更新文档

我不认为一直构建文档是有意义的，但它有助于简化操作，这样当您实际需要更新版本时，您可以非常快速地构建它

您还可以确保使用FXCop或StyleCop（忘记哪个），并将其配置为将丢失的XML文档警告视为错误—至少在发布版本中是这样。为调试配置执行此操作可能会减慢开发速度并使更改变得困难，因为开发人员通常希望在提交值得记录的最终实现之前进行尝试

编辑*

Sandcastle提供了各种输出格式，如项目属性中所示：

我想提一提（我是开发人员），它可能就是您想要的。它被设计为快速和简单，并生成适当的类似MSDN的HTML输出。它还有一个命令行界面，因此您可以在VisualStudio中通过生成后事件命令调用它

---

我想你应该试一试，因为我很想听听你的想法。

谢谢你详细的回答。我要把你的标记为正确。然而，我发现Sandcastle的速度非常慢（因此只需要在发布版本中运行它）。另外，我更喜欢只使用HTML的输出格式。CHM输出的缺点是，如果开发人员打开了文件，则由于文件锁定，生成将失败。我真的很喜欢D'oxygen的输出和易用性…我认为它确实输出HTML，然后才编译成CHM。可能有一些配置选项可以更改输出格式