【发布时间】：2011-01-02 08:18:32
【问题描述】：
我们是一个开发团队，我们需要记录我们的代码。 每个开发人员都在处理可以称为模块的代码的一部分。 我们需要一个具有此规范的文档
- 应该易于实现和使用
- 每个开发人员都记录了她/他自己的工作，当另一个开发人员需要了解任何模块时，他/她不应该有义务向原始开发人员询问文档。他/她应该能够自己找到该文件。
- 我们应该能够搜索整个文档。
您对此有什么建议吗？
【问题讨论】：
-
这真的取决于语言生态系统。指定语言和/或平台可能会产生更好的响应。此外，还应考虑“辅助”文档生成、处理和存储策略。
标签： documentation code-documentation