php - 你用什么工具来记录一个大项目？

Question

我正在和朋友一起做一个项目。这个项目变大了，有很多类、方法、函数、助手等等。

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

您是否使用可以帮助您解决此问题的工具？该代码已记录在案，但我认为阅读每个文件以了解其工作原理有点困难。

谢谢你。

Answer 1

phpDoc会有所帮助，您可以在每个函数之前设置注释，如下所示：

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

大多数主要 IDE 都会读取这些内容，因此您可以在通过代码完成调用函数时看到返回类型。