用什么工具记录你使用的大项目？

Question

我正在与一位朋友在一个项目中工作。这个项目变得很大，有很多类，方法，功能，帮手等等。

我觉得需要一些能够帮助我们读取其他代码的东西。该项目建立在公共框架（laravel）上，是MVC。

你使用的工具可以帮助你吗？代码被记录下来，但我认为阅读每个文件以了解事情的工作原理有点困难。

谢谢。

Answer 1

phpDoc将帮助你建立这样的每一个功能，再发表评论：

/** 
* Returns a user's e-mail address 
* 
* @param int $userId 
* @return string 
*/ 

大多数主要IDE然后读这些，所以你可以看到返回类型，你通过调用函数代码完成。