我正在查看PHPDoc的文档,找不到一个好的方法来记录我发送到各种方法的Post变量。
因此,我开始研究Doxygen,希望它能为我提供一种更好的方法来记录所有这些变量。我的代码涉及很多AJAX请求,所以大多数变量都是通过post发送的。
有没有一种好的方法可以让我在doxygen中记录post变量?我很难确定使用标准参数标记运行时是否会出现错误。
如果没有,是否还有其他文档可能对此过程有所帮助?还是我应该手动记录所有内容,而忽略寻找自动记录工具?
谢谢!
如果方法直接从$_POST读取这些值,而不是作为方法参数,那么我会依赖于方法的docblock中的@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旨在显示双向关系。
文档生成器应该在接收元素的文档中创建一个@usedby标记,该标记链接回与@uses标记关联的元素
因此,尽管在语义上@uses可能读起来更好,但@see也可以用于记录$_[POST|GET|REQUEST]参数。两者之间的主要/唯一区别是@see是指向文档块中引用的FQSEN的单向链接