开发文档

Question

3

我们是一支开发团队，需要记录我们的代码。每个开发人员都负责一个称为模块的代码部分。我们需要一个符合以下规范的文档：

你对此有什么建议吗？

- user560224

1

这真的取决于编程语言生态系统。明确指定语言和/或平台可能会得到更好的回应。此外，还应该考虑“附属”文档生成、处理和存储策略。 - user166390

2个回答

1

你在谈论设计决策、需求等方面吗？

为什么不使用维基（我们使用PmWiki）进行协作呢？

- mtraut

网页内容由stack overflow 提供, 点击上面的

可以查看英文原文，
原文链接

- jamesmortensen · Accepted Answer

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