用什麼工具記錄你使用的大項目？

Question

我正在與一位朋友在一個項目中工作。這個項目變得很大，有很多類，方法，功能，幫手等等。

我覺得需要一些能夠幫助我們讀取其他代碼的東西。該項目建立在公共框架（laravel）上，是MVC。

你使用的工具可以幫助你嗎？代碼被記錄下來，但我認爲閱讀每個文件以瞭解事情的工作原理有點困難。

謝謝。

Answer 1

phpDoc將幫助你建立這樣的每一個功能，再發表評論：

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

大多數主要IDE然後讀這些，所以你可以看到返回類型，你通過調用函數代碼完成。