使用 Doxygen 或 PHPDoc 记录 Get/Post 参数 [关闭]

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

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

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

如果没有，是否有其他文档记录员可能在此过程中提供帮助？或者我应该手动记录所有内容并忽略寻找自动记录工具？

Thanks!

如果这些方法直接从 $_POST 读取这些内容，而不是作为方法参数，那么我会依靠@uses http://phpdoc.org/docs/latest/references/phpdoc/tags/uses.html方法的文档块中的标记：

/**
 * 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”关键字在技术上对于方法内的超全局来说并不是必需的，但它确实有助于将其记录下来。

Edit

请注意，根据 PHPDoc 的参考指南，@uses https://docs.phpdoc.org/guide/references/phpdoc/tags/uses.html旨在显示双向关系。

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

因此，虽然在语义上 @uses 可能读起来更好，@see https://docs.phpdoc.org/guide/references/phpdoc/tags/see.html也可用于记录 $_[POST|GET|REQUEST] 参数。两者之间的主要/唯一区别是 @see 是指向FQSEN https://docs.phpdoc.org/2.9/glossary.html#term-fqsen在文档块中被引用