用PHP编写大型或小型项目的文档？

目前我们正在谈论很多关于程序员的文档。你怎么处理这个零件

将新团队成员引入“大型”PHP项目的最佳方法是什么。一个新人需要什么

到目前为止，我的想法是：

• 好的源代码
• 通过phpdoc生成的api文档
• 清晰的编码风格/准则

某种报纸/维基。。提供有关基础设施（数据库、防火墙等）的信息

如果您必须将您的项目移交给其他人（可能没有您在php中的表现好），您还提供了什么

您是否创建了类似“要添加一个函数来读取服务器数据，将其放入xYZ模型中？”

---

对不起，我的英语很差：）你应该考虑使用这三个词。 但是，尽量不要使文档过于复杂：越难保持最新，就越有可能无法对其进行维护。IMHO，向新程序员介绍代码库的最低要求是编码指南（如何调用变量、如何调用类、是否使用匈牙利符号？）和phpdoc。如果您的代码大量使用第三方库和大型配置文件，请编写一份小型PDF，其中包含使代码在新机器上运行的步骤

如果您使用的是单元测试，请记住也要记录这些测试

---

即使有了这些，在把代码库交给新的编码员之后，也要经常打电话。对你来说，逻辑上的和清晰的可能不是对新来的人。

< P>你应该考虑使用这三个词。 但是，尽量不要使文档过于复杂：越难保持最新，就越有可能无法对其进行维护。IMHO，向新程序员介绍代码库的最低要求是编码指南（如何调用变量、如何调用类、是否使用匈牙利符号？）和phpdoc。如果您的代码大量使用第三方库和大型配置文件，请编写一份小型PDF，其中包含使代码在新机器上运行的步骤

如果您使用的是单元测试，请记住也要记录这些测试

---

即使有了这些，在把代码库交给新的编码员之后，也要经常打电话。你觉得合乎逻辑和清晰的东西可能不适合新来的人。

如果项目有API，那么除了其他之外，我可能会提供示例用法、示例等。

如果项目有API，那么除了其他之外，我可能会提供示例用法、示例等。

文档很好，但可以将其作为指南。它不应该是用来教编程的，也不应该是一个容易写过时的文档

每当我加入一个新项目时，我始终需要知道代码的位置以及如何访问它。将代码行与正常运行的开发或登台环境相匹配，可以快速打开试验和发现以前开发人员的“模式”的大门

如果我能在一个界面上做一些小的调整，那么我已经解决了问题，可以开始朝着数据的方向后退

---

但我已经习惯了加入那些几乎没有文档的项目。并非每个人都对此感到满意。

文档很好，但可以将其作为指南。它不应该是用来教编程的，也不应该是一个容易写过时的文档

每当我加入一个新项目时，我始终需要知道代码的位置以及如何访问它。将代码行与正常运行的开发或登台环境相匹配，可以快速打开试验和发现以前开发人员的“模式”的大门

如果我能在一个界面上做一些小的调整，那么我已经解决了问题，可以开始朝着数据的方向后退

---

但我已经习惯了加入那些几乎没有文档的项目。并不是每个人都喜欢这样。

我为一个中等规模的代码库编写代码，它几乎完全是唯一其他程序员工作的产物（我是新来的）。我们自动美化了来自API phpdoc注释和版本控制最佳实践文本文件的文档。我将放弃这两种方式：更广泛的在线评论和某种自动化测试

我通常认为api文档有助于构建新特性，但对于查找bug并不是特别有用，只有内联注释才能很好地解释这一点

因此，在我自己的工作中，我试图在我接触代码行之前，在注释中展示新代码的行为。我也想转向测试驱动设计，但还没有真正做到这一点

是的，我是一个称职的程序员，但是代码库的大小和复杂性，以及大多数代码是由其他人创建的事实，意味着我必须经常去找他解释潜在的bug来源。因此，如果你真的投入了使代码库在你移动之后继续生存，考虑一下如果你可以的话，让你自己成为一个资源。

---

我认为最重要的事情是（或多个，或其他一些D.V.C.S.），文档记录历史和与它们相关的代码。

< P>我为一个中等大小的代码库编写代码，几乎完全是其他程序员工作的产物（我是新人）。我们自动美化了来自API phpdoc注释和版本控制最佳实践文本文件的文档。我将放弃这两种方式：更广泛的在线评论和某种自动化测试

我通常认为api文档有助于构建新特性，但对于查找bug并不是特别有用，只有内联注释才能很好地解释这一点

因此，在我自己的工作中，我试图展示新代码的行为