开发人员手册
开发人员手册
提问于 2011-09-25 22:07:06
我和我的团队正处于软件开发项目的最后阶段。我们使用Visual Studio来编译我们的项目，并用C#编写代码。我们需要构建用户手册。有没有办法从应用程序和代码的注释中生成用户手册？
回答 3
Stack Overflow用户
回答已采纳
发布于 2011-09-25 22:17:14
假设您已经对代码进行了适当的注释，那么可以使用许多第三方工具来生成文档。
以下列表并不详尽：
我只希望您的最终用户是开发人员，并且您正在编写某种API。这些类型的文档生成工具通常只适用于内部使用或为其创建了可供其使用的API的外部开发人员。
Stack Overflow用户
发布于 2011-09-25 22:12:40
如果你的目标受众是其他开发人员，你可以做一些类似this SO post中提到的事情，但是如果不是开发人员的最终用户，那么代码中的注释不太可能对他们有用，如果他们有用的话……那么它们对开发人员可能就不是那么有用了。
Stack Overflow用户
发布于 2019-03-25 01:05:23
如果您使用的是XML文档，Commments...you可以使用/doc编译选项。
当您使用/doc选项进行编译时，编译器将在源代码中搜索所有
标记并创建一个/doc文档文件。要基于编译器生成的文件创建最终文档，您可以创建自定义工具或使用诸如DocFX或Sandcastle之类的工具。
页面原文内容由Stack Overflow提供。腾讯云小微IT领域专用引擎提供翻译支持
原文链接：
https://stackoverflow.com/questions/7546016
复制相关文章
相似问题
腾讯云开发者
Copyright © 2013 - 2026 Tencent Cloud. All Rights Reserved. 腾讯云 版权所有
深圳市腾讯计算机系统有限公司 ICP备案/许可证号：粤B2-20090059 
粤公网安备44030502008569号
腾讯云计算（北京）有限责任公司 京ICP证150476号 | 京ICP备11018762号