腾讯云

文章/答案/技术大牛

发布

社区首页 >问答首页 >使用Doxygen或PHPDoc记录Get/Post参数

问使用Doxygen或PHPDoc记录Get/Post参数
EN

Stack Overflow用户

提问于 2012-08-03 14:35:40

回答 1查看 3.6K关注 0票数 10

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

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

有没有一个好方法让我在doxygen中记录post变量？我很难确定只运行标准参数标记是否会出现错误。

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

谢谢!

documentation

doxygen

phpdoc

php

回答 1

Stack Overflow用户

回答已采纳

发布于 2012-08-03 19:24:11

如果方法直接从$_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'], "... :-)";
}

我意识到"global“关键字在技术上对于一个方法中的超全局来说并不是必需的，但它确实有助于将其文档化。

编辑

请注意，根据PHPDoc的参考指南，@uses旨在显示双向关系。

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

因此，尽管@uses在语义上可能读起来更好，但也可以使用@see来记录$_POST|GET|REQUEST参数。两者之间的主要/唯一区别是@see是指向文档块中引用的FQSEN的单向链接

票数 8

页面原文内容由Stack Overflow提供。腾讯云小微IT领域专用引擎提供翻译支持

原文链接：

https://stackoverflow.com/questions/11797811

复制

xUtils 的 post和get 请求使用记录

博客

http://blog.csdn.net/lxk_1993/article/details/50897613

103style

2022/12/19

5790

post请求包含哪些参数(请求方式post和get)

编程算法 php http https 网络安全

1）、HTTP 协议是以 ASCII 码传输，建立在 TCP/IP 协议之上的应用层规范。规范把 HTTP 请求分为三个部分：状态行、请求头、消息主体。 2）、协议规定 POST 提交的数据必须放在消息主体（entity-body）中，但协议并没有规定数据必须使用什么编码方式。实际上，开发者完全可以自己决定消息主体的格式，只要最后发送的 HTTP 请求满足上面的格式就可以。 3）、数据发送出去，还要服务端解析成功才有意义。一般服务端语言如 php、python 等，以及它们的 framework，都内置了自动解析常见数据格式的功能。服务端通常是根据请求头（headers）中的 Content-Type 字段来获知请求中的消息主体是用何种方式编码，再对主体进行解析。

全栈程序员站长

2022/07/29

3.9K0

GET && POST

https php http 网络安全 c++

简介 GET和POST是两种常用的HTTP方法，GET在URL提交参数，而POST实在请求体中提交参数，所以在提交多少内容的方面上，POST是略胜一筹，因为GET是在URL提交内容的，而URL最长的长度是2048个字符，POST是无限制的，同时，GET的安全性也没有POST安全，因为在GET中，所有提交上去的参数都说可见的，比如http://127.0.0.1/login.php，如果我们登录是以GET方式提交的，那么，账户密码也会出现在URL栏处，比如:http://127.0.0.1/login.ph

vFREE

2021/12/20

3.9K0

-GET和POST请求添加请求参数和请求头【TBK使用】

http 网站

我们平常浏览各个网站时，不免有时候就需要填写一些信息，比如注册时，登录时，这些信息一般都是通过GET请求或者POST（敏感信息一般使用POST，数据隐藏，相对来说更安全)请求提交到后台，经过后台的一系列处理，再返回给前台结果，前台进行处理。

凯哥Java

2019/06/28

6.6K0

requestmethod post和get_post与get

https java 网络安全

发布者：全栈程序员栈长，转载请注明出处：https://javaforall.cn/193294.html原文链接：https://javaforall.cn

全栈程序员站长

2022/09/27

1K0

Get&Post

即时通信 IM

邓哥家住在吃鸡村，邓嫂家住在农药屯。邓哥到邓嫂家可以有很多种选择，走着去、驾车去、坐火车去等等。邓哥通常选择驾车过去。

HLee

2021/02/03

1.2K0

详解用 MiniFramework 框架实现对 GET 或 POST 请求参数进行签名校验的方法

app get post sha1 sign

在一些特殊场景下，我们可能希望对于 GET 或 POST 进入到接口的数据进行签名和有效期的校验，例如 APP 请求后端接口的场景，我们通常需要考虑两个问题：

魏杰

2022/12/23

7890

Java中Get和Post的使用

https github 网络安全 git 开源

项目地址：https://github.com/Snowstorm0/learn-get-post

代码的路

2022/08/23

9620

php使用curl可以get 模拟post

php java 命令行工具腾讯云开发者社区

Curl.php可以使用http://www.myquickphp.com/的框架中的组件Curl.php

Java架构师必看

2021/03/22

1.5K0

Python Request get post 代理基本使用

php https http 网络安全 json

关于文件上传可参考我的这篇博客:requests post 文件上传https://blog.csdn.net/EXIxiaozhou/article/details/126975807

EXI-小洲

2022/12/13

4640

【OkHttp】OkHttp Get 和 Post 请求 ( 同步 Get 请求 | 异步 Get 请求 | 同步 Post 请求 | 异步 Post 请求 )

get 对象配置同步异步

韩曙亮

2023/03/29

16.7K0

Doxygen工具简单使用

html c++apt-get markdown 编程算法

Doxygen是一款非常方便的文档生成工具，以类似JavaDoc风格描述的文档系统，完全支持C、C++、Java等语言，据说也支持python等。用他不仅可以根据注释生成文档，而且还能利用graphviz工具生成类图以及类中的函数调用关系，并且支持html、latex、rtf等格式的输出。

mythsman

2022/11/14

1K0

Golang 获取GET、POST参数及处理上传多个文件

http.request的三个属性Form、PostForm、MultipartForm:

IT工作者

2022/06/30

2.1K0

60秒GET小技能-爬虫快速构建post参数法

http html php 编程算法网络安全

一个爬虫小技巧，只需要60秒即可阅读完毕，高手勿喷，仅供初学者轻松构造post参数和header与cookie构建

十四君

2022/04/02

4320

POST请求和GET请求如何传递和接收解析参数

http mvc spring php 编程算法

接口参数应该怎么传递是每个项目应该面对的问题，这跟编程语言无关，今天来总结一波常用的接口参数传递方式。

码农小胖哥

2020/10/10

27K0

Ajax的get与post的区别，什么时候使用post？

缓存 http

　　get和post在HTTP中都代表着请求数据，其中get请求相对来说更简单、快速，效率高些

红目香薰

2022/11/29

6800

GET 和 POST 区别

腾讯云测试服务编程算法 http

浏览器的get和post有什么区别？第1个从他们字面意思去理解这些，就是从网页上获取一个数据。然后这个获取数据是对服务器不会产生副作用的，术语就是数学上的幂等即多次操作不产生影响（比如任何数乘1或者乘0，多次乘之后，都不会变化），那样多次操作也不会去产生副作用。那post那这个就是一个单词就是邮寄的意思，相当于是要本地的数据传到服务器，那这个操作就会对服务器的数据更新或者创建，就会造成一个影响，它是有副作用的，对应的就是不幂等。

叉叉敌

2020/08/25

7930

GET、POST编码问题

spring mvc

GET请求、POST经常会出现中文乱码的问题，最好约定前后端的编码，一般为UTF-8。但是这里面也是有坑的。后端设置编码为UTF-8的推荐方式： SpringMVC配置过滤器： <filter> <filter-name>characterEncodingFilter</filter-name> <filter-class>org.springframework.web.filter.CharacterEncodingFilter</filter-class> <ini

欠扁的小篮子

2018/07/04

6880

jersey之get，put，post，delete简单使用

maven https asp

　　要使用jersey首先要有相应的依赖包，获取方法有很多，本地下载依赖文件或maven获取，这里假设你的环境已经搭建好了。要使用jersey首先要初始化一个client客户端，下面是最简单的一个get请求

用户2038589

2018/09/06

8110

PHP使用CURL模拟POST和GET请求

php http 命令行工具

在PHP中想要构造类似GET和POST请求，在一些APP或者等后端功能开发中是有这种需求。在PHP语言当中有file_get_content ()函数和curl的支持。在PHP>5.3 的版本中默认两者都是开启的。

2020/04/21

2.4K0

相似问题

PHPDoc中的Post参数

PHPDoc:使用可变数量的参数记录函数

使用Doxygen或类似命令记录枚举标志

jQuery .post或.get传递动态参数

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

添加站长进交流群

领取专属 10元无门槛券

AI混元助手 在线答疑

关注 腾讯云开发者公众号

洞察 腾讯核心技术

剖析业界实践案例

社区富文本编辑器全新改版！诚邀体验～

全新交互，全新视觉，新增快捷键、悬浮工具栏、高亮块等功能并同时优化现有功能，全面提升创作效率和体验

问使用Doxygen或PHPDoc记录Get/Post参数
EN