3

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

  1. 它应该易于实现和使用
  2. 每个开发人员都记录了她/他自己的工作，当另一个开发人员需要了解任何模块时，他/她不应该有义务向原始开发人员询问文档。他/她应该能够自己找到该文件。
  3. 我们应该能够搜索整个文档。

你对此有什么建议吗？

4

2 回答 2

4

大多数语言都有一种从代码注释生成文档的方法。Java 和 JavaScript 都有将注释转换为 API 规范的方法，例如 Java 的 Javadocs。这实际上取决于您使用的平台。

于 2011-01-02T08:24:27.427 回答
1

你谈论设计决策、要求等？

为什么不使用 wiki（我们使用 PmWiki）进行此类协作？

于 2011-01-02T10:29:27.220 回答