文章/答案/技术大牛

发布

社区首页 >问答首页 >发展文件

问发展文件
EN

Stack Overflow用户

提问于 2011-01-02 08:18:32

回答 2查看 376关注 0票数 3

我们是一个开发团队，我们需要记录我们的代码。每个开发人员都在代码的一部分上工作，这部分代码可以称为模块。我们需要有这个规范的文档。

实现和使用
应该很容易--每个开发人员都会记录自己的工作，而当另一个开发人员需要了解任何模块时，他/她就不必向原始开发人员询问文档。他/她应该能够自己找到这份文件。
我们应该能够搜索整个文档。

你对此有什么建议吗？

documentation

code-documentation

回答 2

Stack Overflow用户

发布于 2011-01-02 08:24:27

大多数语言都有从代码注释生成文档的方法。Java和JavaScript都有将注释转换为API规范的方法，比如Java的Javadocs。这取决于你使用的是哪个平台。

票数 4

Stack Overflow用户

发布于 2011-01-02 10:29:27

你说的是设计决策、需求等等吗？

为什么不使用wiki (我们使用PmWiki)来进行这样的协作？

票数 1

页面原文内容由Stack Overflow提供。腾讯云小微IT领域专用引擎提供翻译支持

原文链接：

https://stackoverflow.com/questions/4577693

复制

相似问题

问发展文件
EN

回答 2

Stack Overflow用户

Stack Overflow用户

社区

活动

圈层

关于

腾讯云开发者

热门产品

热门推荐

更多推荐

问发展文件EN

回答 2

Stack Overflow用户

Stack Overflow用户

社区

活动

圈层

关于

腾讯云开发者

热门产品

热门推荐

更多推荐

问发展文件
EN