PhpStorm函数注释的设置

首先,PhpStorm中文件、类、函数等注释的设置在:setting-》Editor-》FIle and Code Template-》Includes下设置便可,其中方法的默认是这样的:yii

/**
${PARAM_DOC}
#if (${TYPE_HINT} != "void") * @return ${TYPE_HINT}
#end
${THROWS_DOC}
*/

可是我发现,文件中的默认注释是这样的:函数

1 /**
2  * Created by ${PRODUCT_NAME}.
3  * User: ${USER}
4  * Date: ${DATE}
5  * Time: ${TIME}
6  */

当我把上面这段中三、四、5行的代码直接复制放到PHP Function Doc Comment这个下面的时候,发现其中占位符{}中的东西并无被替换,而是当成字符串打出来了。spa

方法:code

一、咱们在PhpStorm中setting-》Editor-》Live Template,即找到模板选项,会看到各类语言的模板设置;orm

二、找到右边有个+号,建立一个自定义模板:选择Live Template,而后按照下图的配置顺序进行设置:blog

三、点保存以后,回到FIle and Code Template-》Includes,在PHP Function Doc Comment这里设置:接口

/**
 * Notes:
 * User: ${USER}
 * Date: ${DATE}
 * Time: ${TIME}
${PARAM_DOC}
#if (${TYPE_HINT} != "void") * @return ${TYPE_HINT}
#end
${THROWS_DOC}
*/

四、点击Apply,点击OK,而后在方法前面,输入 /**后回车:字符串

 

/**
     * Notes:下单接口
     * User: Steven
     * Date: 2017/12/28
     * Time: 15:19
     * @return array
     * @throws \yii\db\Exception
     */

OK,完成。it

相关文章
相关标签/搜索