PHP常用注解

@param 参数类型参数参数说明：注解方法中的参数

/**
 * 格式化字符串
 * @param string $str 要格式化的字符串
 */
function format($str){
    ...
}

1
2
3
4
5
6
7

@return 返回类型：注解方法返回类型

/**
 * 格式化字符串
 * @param string $str 要格式化的字符串
 * @return boolean
 */
function format($str){
    ...
    return true;
}

1
2
3
4
5
6
7
8
9

@access protected|public|private：注解类方法的访问类型

/**
 * 格式化字符串
 * @access protected
 * @param string $str 要格式化的字符串
 * @return boolean
 */
protected function format($str){
    ...
    return true;
}

1
2
3
4
5
6
7
8
9
10

@throws Exception：注解方法抛出异常

/**
 * 格式化字符串
 * @access protected
 * @param string $str 要格式化的字符串
 * @return boolean
 * @throws Exception
 */
protected function format($str){
    ...
    return true;
}

1
2
3
4
5
6
7
8
9
10
11

@var 类型说明：注解类变量

class Api{
    /**
     * @var User 会员实例
     */
    protected $user = null;
}

1
2
3
4
5
6

@package 包：注解类包

/**
 * @package api
 */
class Api{
    ...
}

1
2
3
4
5
6

@method 返回类型方法注释：注解类拥有的方法

/**
 * @method void onAfterInsert(Model $model) static after_insert事件定义
 */
class Api{
    public static onAfterInsert(Model $model){
        ...
    }
}

1
2
3
4
5
6
7
8

@property 返回类型变量名注释：注解类拥有的属性，可以用来IDE智能提示用

/**
 * @property int $id 主键ID
 */
class Api{
    ...
}

1
2
3
4
5
6

TODO：待完成任务

// TODO 后期加入...

#php

上次更新: 2023/09/22, 16:54:32

← PHP curl常见CURLE_SSL_CACERT (60)错误及get,post实例 PhpSpreadsheet操作Excel的基本使用→