PHP常用注释标签 - Abigeater Log😊

如果使用PHPStorm进行开发，给自己的代码加上注释标签后能提高开发效率。

文件头位置注释标签：

<?php
/**
 * @author 作者
 * @contact 联系方式
 * @description 这个文件的作用
 * @date 创建日期
 */

我会常在文件的首行增加这些注解；

@deprecated 方法/类弃用说明

如果使用了deprecated并且有替换的函数可搭配@see标签，整体参考用法：

/**
 * @var string 用户邮箱
 * @deprecated 1.0 不建议使用
 * @see user_info 建议使用该参数替代
 */
public $email;

@see 链接/内部类

@link 链接

一般@see用在文件内跳转，@link跳转到外部链接，比如该方法是对接第三方接口文档。

/** @var string $name 姓名 */
public $name;

如果类内声明变量，通过@var的方式声明变量文件类型和其意义，而且可以用在编写的代码里面，比如foreach

/**
 * @var int $i
 * @var MusicInfo $object
 */
foreach ($allMusicObject as $i => $object) {
    ....
}

在代码段声明后，比如$object声明了一个类，可以在代码段内输入$object后PHPStorm就会只提示该类的方法:

在方法或函数内可声明：

/**
 * @param Context $context
 * @param string $id
 * @param array $request
 * @return bool
 * @throws ResponseException
 */
public function do_something(Context $context, string $id, array $request): bool

@param声明传参类型，@return返回的类型，@thorws声明可能抛出的异常

如果你的类使用__call或者__callStatic这类方法，需要在类通过@method声明可调用的函数，不然PHPStorm不会智能提示，例:

/**
 * @method bool insert($data)
 * @method bool update($id, $data)
 * @method bool delete($id, $data)
 */
class Store

声明后，在使用该类时会提示对应方法：

相关文章