如何使用PHPdoc記錄數據庫使用情況？

Question

現在我想知道如果其他人記錄函數頭中的數據庫使用情況...例如，fn（）可能讀取或寫入數據庫（或其表），或者創建，修改或刪除數據庫或表。 （側面的問題：應該使用「USE xxx」修改數據庫的fn（）'記住'當前數據庫的入口並在退出前再次使用它？）

在我看來，這種事情應該記錄，但如何最好地這樣做？ @uses，還是什麼？

Answer 1

爲什麼不使用@link和一個列表，與助手的名單一起：

/** 
* Some comments here. 
* 
* Helper functions: 
* * {@link someHelper} 
* * {@link theOtherHelper} 
* 
* Reads tables: 
* * {@link Table1} 
* * {@link Table2} 
* 
* Reads/Writes tables: 
* * {@link Table3} 
* * {@link Table4} 
*/ 

然後你做這些表的一些話題頁，只是一個簡短的描述，「認爲業務流程X參數「。