使用Doxygen或PHPDoc记录Get/Post参数

我正在查看PHPDoc的文档，但找不到一个好方法来记录发送给各种方法的Post变量

所以，我开始研究Doxygen，希望它能为我提供一种更好的方法来记录所有这些变量。我的代码涉及大量AJAX请求，因此大多数变量都是通过post发送的

有没有一个好方法可以让我在doxygen中记录post变量？我很难确定仅仅使用标准参数标记运行是否会出现错误

如果没有，是否有其他文档管理员在这个过程中可能会有所帮助？或者我应该手动记录所有签名，忽略寻找自动记录工具吗

---

谢谢

如果这些方法直接从$\u POST中读取，而不是作为方法参数，那么我会依靠方法的docblock中的标记：

/**
 * 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'], "... :-)";
}

我意识到“global”关键字在技术上对方法中的超全局性不是必需的，但它确实有助于将其记录在案

---

编辑

请注意，根据PHPDoc的参考指南，它旨在显示双向关系

文档生成器应该在接收元素的文档中创建一个@used by标记，该标记链接回与@uses标记关联的元素

---

因此，尽管@uses在语义上可能读得更好，但它也可以用于记录$_[POST | GET | REQUEST]参数。两者之间的主要/唯一区别在于@see是指向文档块中引用的文档的单向链接

谢谢，我认为@uses是个好主意！“全局”听起来似乎在任何地方添加都有点烦人，但如果另一种方法不起作用，我会研究一下。嘿，对不起，这有点晚了，但我是PHP文档的新手。我使用了@uses，但有个小问题。documentor的API只显示方法名，然后显示函数名。它不显示后面的描述。我如何让描述显示出来？目前，它看起来只是使用了| CLASSNAME/FUNCTIONNAME/VARIABLE。但是，我希望描述在后记中出现。