php – 是否有用于记录GET / POST参数的标准?

前端之家收集整理的这篇文章主要介绍了php – 是否有用于记录GET / POST参数的标准?前端之家小编觉得挺不错的,现在分享给大家,也给大家做个参考。
PHP项目中,即使前端控制器逻辑用于主应用程序,也可以有许多独立脚本,ajax代码片段等.

有没有一个标准化的方法PHPDoc或其他东西 – 在脚本的第一个注释块中定义脚本将接受/要求的GET和/或POST参数以及它们的类型?

我通常只需要添加@params来帮助自己,就像文件是一个函数一样,还有一个@return解释脚本的作用和返回,但也许有一种更专业的方式,我不知道.

PHPDocumentor不会喜欢文件级docblock中的@param和@return标签

如果您选择一个单独的文件来记录它们,根据Mr-sk的答案,您可以使用@link指向那里,但不会立即在您的文件的文档页面中看到…它只是一个超链接你必须点击去查看信息.如果您希望任何该文件内容在您的脚本文件的文档页面上可见,您可以使用内联{@example}标记来指向它,或者甚至只是其中的某些行. {@example / path / to / file 3 5}只显示三到五行.

在这种情况下,我可能会选择在文件级docblock的长描述中解释这些东西,因为实际上并没有直接的方法来将参数标记PHPDocumentor将其识别为代码元素.如果我的描述中使用的任何参数确实是代码中的其他代码代码元素,那么我将使用内联{@link}标记来指向该代码元素.

例如,假设在另一个代码文件中定义了一些常量,并且在解析其他文件生成这些元素的自己的文档.如果我在一个仅脚本文件(如你的文件)的文件级docblock中编写的长描述将这些常量作为参数进行说明,那么我的句子可能是:

如果设置$POST [‘foo’],其值应始终为{@link BAR_CONST}或{@link BAZ_CONST}.

参考文献:

> inline {@example} – http://manual.phpdoc.org/HTMLSmartyConverter/HandS/phpDocumentor/tutorial_tags.inlineexample.pkg.html
> inline @ {link} – http://manual.phpdoc.org/HTMLSmartyConverter/HandS/phpDocumentor/tutorial_tags.inlinelink.pkg.html

原文链接:https://www.f2er.com/php/139494.html

猜你在找的PHP相关文章