开发者手册答案

【问题标题】：developer manuals开发者手册
【发布时间】：2011-11-24 15:38:09
【问题描述】：

我和我的团队正处于软件开发项目的最后阶段。我们正在使用 Visual Studio 编译我们的项目并使用 C# 进行编码。我们需要建立用户手册。有没有办法从应用程序和代码的cmets生成用户手册？

【问题讨论】：

用户是最终用户还是开发者？（你是在写库还是 GUI？）
如果您认为您的用户需要知道您的代码中发生了什么，那么我真的希望您的用户：永远不需要阅读手册（如果他们这样做了，上帝保佑），或者，可以访问源代码和 5 年编程经验。

【解决方案1】：

假设您已经适当地注释了您的代码，那么您可以使用许多第三方工具来生成文档。

以下列表并不详尽：

我只是希望您的最终用户是开发人员，并且您正在编写某种 API。这类文档生成工具通常只适合内部使用或您为其创建了可供他们使用的 API 的外部开发人员。

【讨论】：

【解决方案2】：

如果您的目标受众是其他开发人员，您可以执行this SO post 中提到的类似操作，但如果最终用户不是开发人员，那么您代码中的 cmets 不太可能对他们有用，如果它们是……那么它们可能对开发人员没有那么有用。

【讨论】：

【解决方案3】：

如果您使用的是 XML 文档注释...您可以使用 /doc 编译选项。

当您使用 /doc 选项进行编译时，编译器将搜索源代码中的所有 XML 标记并创建一个 XML 文档文件。根据编译器生成的最终文档文件，您可以创建自定义工具或使用 DocFX 或沙堡。

【讨论】：