0

我们有一群开发人员从 C++ 转向 C# 和 WinRT。我们将 D'Oxygen 用作 C++ 开发人员构建的一部分，我希望继续将文档生成作为 C#/WinRT 开发人员构建的一部分。

启用 XML Doc 生成很容易，我相信这会为格式错误的标签提供警告，但如果没有实际的 HTML 输出，我认为我们的开发人员会错过有价值的反馈。

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

如果有人在 C#/WinRT 中有过执行此操作的经验，我肯定希望得到一些建议。

提前致谢！

4

2 回答 2

1
  1. 获取Sandcastle 帮助文件生成器。
  2. 在 Visual Studio 解决方案中为您的库创建一个帮助项目。
  3. 从调试解决方案配置中删除构建复选标记以仅在发布配置中构建文档项目，因为调试在开发过程中最常使用。对于发布构建测试或性能测试，您可以创建另一个解决方案配置或简单地来回切换选项。
  4. 构建文档一次
  5. 在解决方案中包含文档文件，以便在文件更改时显示在 Pending Changes 窗口中。
  6. 请让您的开发人员在签入之前使用更新文档的发布配置进行构建，或使用任何其他策略来要求更新文档。

配置管理器启动 为调试配置禁用文档构建的配置管理器 便于查看和签入 .chm 文件更新的解决方案结构

我不认为一直构建文档是有意义的，但它有助于简化操作，以便在您真正需要更新版本时 - 您可以非常快速地构建它。

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

编辑*

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

在此处输入图像描述

于 2013-02-07T05:37:09.677 回答
1

我想提一下ForgeDoc（我是其中的开发人员），它可能是您正在寻找的东西。它的设计目的是快速和简单，并生成适当的类似 MSDN 的 HTML 输出。它还具有命令行界面，因此您可以从 Visual Studio 中的构建后事件命令中调用它。

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

于 2013-02-10T06:31:16.667 回答