PhpStorm 头部注释、类注释和函数注释的设置(稍微完善点)
首先,PhpStorm中文件、类、函数等注释的设置在:setting-》Editor-》FIle and Code Template-》Includes下设置即可,其中方法的默认是这样的:
/**
${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 */
当我把上面这段中3、4、5行的代码直接复制放到PHP Function Doc Comment这个下面的时候,发现其中占位符{}中的东西并没有被替换,而是当成字符串打出来了。
方法:
1、我们在PhpStorm中setting-》Editor-》Live Template,即找到模板选项,会看到各种语言的模板设置;
2、找到右边有个+号,创建一个自定义模板:选择Live Template,然后按照下图的配置顺序进行设置:
3、点保存之后,回到FIle and Code Template-》Includes,在PHP Function Doc Comment这里设置:
/**
* @Notes:
* @Interface ${NAME}
${PARAM_DOC}
#if (${TYPE_HINT} != "void") * @return ${TYPE_HINT}
#end
${THROWS_DOC}
* @author: Chenrui
* @Time: ${DATE} ${TIME}
*/
4、点击Apply,点击OK,然后在方法前面,输入 /**后回车:
/**
* @Notes:
* @Interface put_token
* @param $data
* @return string
* @author: Chenrui
* @Time: 2018/5/9 18:05
*/
我自己设置
/**
${PARAM_DOC}
#if (${TYPE_HINT} != "void") * @return ${TYPE_HINT}
#end
${THROWS_DOC}
User: lxw
Date: ${DATE} ${TIME}
*/
OK,完成。
---------------------
版权声明:本文为CSDN博主「chenrui310」的原创文章,遵循CC 4.0 by-sa版权协议,转载请附上原文出处链接及本声明。
原文链接:https://blog.csdn.net/chenrui310/article/details/80257433
赞赏码
非学,无以致疑;非问,无以广识