记录您使用的大项目的工具有哪些?

时间:2013-04-20 15:51:31

标签: php documentation project

我和朋友在一个项目上工作。这个项目变得很大,有很多类,方法,函数,助手等。

我觉得有必要帮助我们阅读其他代码。该项目建立在公共框架(laravel)之上,它是MVC。

您是否使用可以帮助您的工具?代码已记录在案,但我认为阅读每个文件有点难以找出工作原理。

谢谢。

1 个答案:

答案 0 :(得分:3)

phpDoc会有所帮助,您可以在每个函数之前设置注释:

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

然后大多数主要的IDE读取这些,所以当您通过代码完成调用该函数时,您将能够看到返回类型。