我和我的团队正处于软件开发项目的最后阶段。我们正在使用 Visual Studio 编译我们的项目并使用 C# 进行编码。我们需要建立用户手册。有没有办法从应用程序和代码的注释中生成用户手册？
问问题
113 次
3 回答
1
假设您已经适当地注释了您的代码，那么您可以使用许多第三方工具来生成文档。
以下列表并不详尽：
- 沙堡
- NDoc
- Doc-O-Matic
- VSdocman
- 多氧
- ...
我只是希望您的最终用户是开发人员，并且您正在编写某种 API。这些类型的文档生成工具通常只适合内部使用或您为其创建了他们可以使用的 API 的外部开发人员。
于 2011-09-25T14:17:13.773 回答
0
如果您的目标受众是其他开发人员，您可以执行此 SO 帖子中提到的类似操作，但如果最终用户不是开发人员，那么您的代码中的注释不太可能就是所有这些对他们有用，如果他们......那么他们可能对开发人员没有那么有用。
于 2011-09-25T14:12:39.703 回答
0
如果您使用的是 XML 文档注释...您可以使用/doccompile 选项。
当您使用 /doc 选项进行编译时，编译器将搜索源代码中的所有 XML 标记并创建一个 XML 文档文件。要基于编译器生成的文件创建最终文档，您可以创建自定义工具或使用 DocFX 或 Sandcastle 等工具。
于 2019-03-24T17:05:23.157 回答