用Doxygen或PHPDoc記錄獲取/發佈參數

Question

我正在瀏覽PHPDoc的文檔，找不到一個很好的方式來記錄我發送給各種方法的Post變量。

因此，我開始研究Doxygen，希望它能爲我提供更好的方法來記錄所有這些變量。我的代碼涉及很多AJAX請求，因此大多數變量都是通過post發送的。

有沒有一種很好的方式來記錄doxygen中的post變量？我無法確定是否會使用標準參數標記運行錯誤。

如果沒有，是否有另一個文檔可能有助於此過程？或者我應該手動記錄everythign並忽略尋找一個自動記錄工具？

謝謝！

Answer 1

如果方法是直接從$ _ POST讀那些，而不是作爲方法的參數，那麼我會倚在方法的文檔塊的@uses標籤：

/** 
* My foo() method 
* @return void 
* @uses $_POST['bar'] directly 
*/ 
public function foo() 
{ 
    echo "I use ", $_POST['bar'], "... :-)"; 
} 

另一種選擇可能是@global標籤：

/** 
* My bar() method 
* @return void 
* @global mixed uses the 'bar' key from the $_POST superglobal directly 
*/ 
public function foo() 
{ 
    global $_POST; 
    echo "I use ", $_POST['bar'], "... :-)"; 
} 

我意識到，「全局」關鍵字在技術上並不是技術上需要的，但它確實有助於將它記錄下來。

---

編輯

注意，根據PHPDoc的參考指南，@uses是爲了表明一種雙向的關係。

文檔生成應創建接收元件的鏈接回與@uses標籤相關

因此該元素的文檔中使用，通過標籤的@，雖然語義@uses可能更好地閱讀，@see也可以用來記錄$ _ [POST | GET | REQUEST]參數。兩者之間的主要/唯一區別在於@see意味着單向鏈接到FQSEN被引用的文檔塊