10

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

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

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

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

谢谢！

4

1 回答 1

8

如果这些方法是直接从 $_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旨在显示双向关系。

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

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

于 2012-08-03T19:24:11.313 回答