是否有记录 GET/POST 参数的标准？-解网

问：

在PHP项目中，即使前端控制器逻辑用于主应用程序，也可以有许多独立的脚本，ajax片段等。

有没有一种标准化的方法 - 无论是 PHPDoc 还是其他东西 - 在脚本的第一个注释块中定义脚本将接受/需要哪些 GET 和/或 POST 参数以及它们属于哪种类型？

我通常通过添加 s 来帮助自己，就好像文件是一个函数一样，并解释脚本执行和返回的内容，但也许有一种我不知道的更专业的方法。@param@return

php javadoc doxygen phpdoc

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

在这种情况下，我可能会选择只在文件级文档块的长描述中解释内容，因为实际上没有一种直接的方法来标记您的参数，无论如何 phpDocumentor 都会将它们识别为代码元素。如果我在描述中使用的任何参数确实是源自代码中其他位置的记录代码元素，我将使用内联 {@link} 标记来指向该代码元素。

例如，假设在另一个代码文件中定义了一些常量，并且在分析另一个文件时会生成这些元素自己的文档。如果我在纯脚本文件（如您的文件）的文件级文档块中编写的长描述将这些常量作为参数，那么我的句子可能是：

If $POST['foo'] is set, its value should always be either {@link BAR_CONST} or {@link BAZ_CONST}.

引用：

内联 {@example} -- http://manual.phpdoc.org/HTMLSmartyConverter/HandS/phpDocumentor/tutorial_tags.inlineexample.pkg.html
内联 @{link} -- http://manual.phpdoc.org/HTMLSmartyConverter/HandS/phpDocumentor/tutorial_tags.inlinelink.pkg.html

1赞 ursuleacv 5/12/2016 #3

我会使用或目前正在使用，因为它读起来更好并且有意义@uses@see@uses

参考： https://phpdoc.org/docs/latest/references/phpdoc/tags/uses.html

上一个：为老式文件上传添加不显眼的进度条

下一个：在 Javascript 的 URL 中查找基本名称

是否有记录 GET/POST 参数的标准？

Is there a standard for documenting GET/POST parameters?

评论