开发手册

本文关键字:开发 | 更新日期: 2023-09-27 18:09:40

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

开发手册

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

下面的列表并不详尽:

  • 沙塔
  • NDoc
  • Doc-O-Matic
  • VSdocman
  • Doxygen

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

如果你的目标受众是其他开发人员,你可以做一些像这篇文章中提到的事情,但如果是最终用户不是开发人员,那么你代码中的注释对他们来说就不太可能有用了,如果他们是……那么它们对开发人员来说可能就不是那么有用了。

如果您正在使用XML文档注释…你可以使用/doc编译选项。

XML文档注释

当你使用/doc选项编译时,编译器将搜索删除源代码中的所有XML标记,并创建XML文档文件。创建基于编译器生成的最终文档文件,您可以创建自定义工具或使用工具,如DocFX或沙塔。