开发人员手册

时间:2011-09-25 14:07:06

标签: c# automation manual

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

3 个答案:

答案 0 :(得分:1)

假设您已恰当地评论了您的代码,您可以使用许多第三方工具来生成文档。

以下列表并非详尽无遗:

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

答案 1 :(得分:0)

如果您的目标受众是其他开发人员,您可以执行this SO post中提到的内容,但如果是非开发人员的最终用户,则代码中的注释不太可能是对他们来说是有用的,如果他们是......那么他们可能对开发人员来说并不是那么有用。

答案 2 :(得分:0)

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

XML Documentation Comments

  

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