Documentation 开发文档
我们是一个开发团队，我们需要记录我们的代码。 每个开发人员都处理一部分可以作为模块调用的代码。 我们需要一份包含此规范的文档Documentation 开发文档,documentation,code-documentation,Documentation,Code Documentation,我们是一个开发团队，我们需要记录我们的代码。 每个开发人员都处理一部分可以作为模块调用的代码。 我们需要一份包含此规范的文档 它应该易于实现和使用 每个开发人员记录自己的工作，当另一个开发人员需要了解任何模块时，他/她不必向原始开发人员询问文档。他/她应该能够自己找到文件 我们应该能够搜索整个文档 您对此有什么建议吗？大多数语言都有从代码注释生成文档的方法。Java和JavaScript都有将注释转换为API规范的方法，比如Java的Javadocs。这实际上取决于您使用的平台。您讨论的是设计决
您对此有什么建议吗？大多数语言都有从代码注释生成文档的方法。Java和JavaScript都有将注释转换为API规范的方法，比如Java的Javadocs。这实际上取决于您使用的平台。您讨论的是设计决策、需求等吗
为什么不使用wiki（我们使用PmWiki）进行这种协作呢？的确如此。VS/.NET、Scala、Perl、Python、Ruby等也是如此。语言和生态系统在“可接受”（且易于使用）的工具中起着重要作用。这实际上取决于语言生态系统。指定语言和/或平台可能会产生更好的响应。此外，可能还应考虑“辅助”文档生成、处理和存储策略。