phpdoc 疑问,希望使用过的同学帮忙看下。
在写文档的时候碰到下面的情况,控制器里面的参数不是通过形参传递的,是直接通过$_POST获取的($this->params()),这样在使用phpdoc生成文档的时候,在"Parameters"就不会生成相应的参数列表了,希望是可以直接通过声明@param生成文档,不需要根据形参去生成文档。具体的代码和生成的文档截图如下:
<?php
/**
* 测试使用phpdoc生成文档
*
* 测试使用phpdoc生成文档,因为碰到参数显示的问题,所以写了这个展示的例子
*
* @category API
* @package user
* @author dwer <xxx@sina.cn>
* @copyright 2015 api
* @license http://opensource.org/licenses/gpl-2.0.php GNU General Public License
* @version V0.1
* @link http://www.xxx.com
*
*/
class indexAction extends ApiController {
/**
* 根据查询参数获取用户的信息
* @author dwer
*
* @param string age 用户的年纪
* @param string nickname 用户的昵称
* @param string school 用户的毕业学校
* @param string height 身高
* @param string $testParam 测试使用的参数, 只有这个参数会在文档里面显示出来
*
* @return array 返回数据
* [
* {
* "id":"1234",
* "name":"xxxx"
* }
* ]
*/
public function getUser($testParam){
//获取查询参数
$params = $this->params();
$age = $params['age'];
$nickname = $params['nickname'];
//查询数据 .......
}
}
推荐文章: