PHPStorm使用之四(添加文档注释)

之前有提到注释,那注释能不能自动生成呢
答案是肯定的,设置如下图:

在这里插入图片描述

step1
file ----- setting ---- editor ------ file and code templates

step2
选择左侧的需要文档注释的模块 比如 函数

step3
编写注释文档,一般有默认的文档,不需要改动
只是我们在添加部分注释规则的时候,如果需要用到变量
比如 : 日期
在注释内容的下方 Description 里找到可以用的变量 ${DATE}
加在注释内容里

 * @date ${DATE}

step 5 & 6
应用 后 确定

step7
使用方式是,先声明函数 比如:

public function add($a = 0, $b = 0)
{
    return $a + $b;
}

然后在 函数上方的行首输入 /** ,回车
即可看到注释自动添加完成

/**
 * @todo: 要做啥
 * @author:friker
 * @date: 2018/12/12
 * @param int $a
 * @param int $b
 * @reutrn int
 */
public function add($a = 0, $b = 0){
    return $a + $b;
}

猜你喜欢

转载自blog.csdn.net/wujiangwei567/article/details/85236953