phpstorm有将注释设置好能为代码注释带来很多方便。今天就把我的设置过程给大家分享一下。
PhpStorm中文件、类、函数等注释的设置在如下位置:
打开preferences
左侧导航栏找到Editor
然后定位到FileandCodeTemplates
然后右侧tab上选择includes
一、文件头PHPFileHeader
将代码拷贝到到右侧模板位置
/**
*Createdby${PRODUCT_NAME}
*User:xxx根据自己情况设置
*Date:${DATE}
*Time:${TIME}
*Brief:
*docs:
*/
根据需要适当增删
二、函数注释
同理将代码拷贝到右侧模板位置根据自己需要进行增删
/**
*
Desc:${PARAM_DOC}
#if(${TYPE_HINT}!="void")*
return${TYPE_HINT}#end
${THROWS_DOC}
*
author:xxx*
Time:${DATE}${TIME}*/
保存后如果不生效可能是filetab下配置有点问题
查看filetab下的PHPFile内容是否为下图所示内容,如果不实则改为如下内容应用确定即可生效
配置完大功告成!
配置中常用的变量如下,可供诸君参考:
${FILE_NAME}currentfilename
${USER}currentusersystemloginname
${DATE}currentsystemdate
${TIME}currentsystemtime
${YEAR}currentyear
${MONTH}currentmonth
${MONTH_NAME_SHORT}first3lettersofthecurrentmonthname.Example:Jan,Feb,etc.
${MONTH_NAME_FULL}fullnameofthecurrentmonth.Example:January,February,etc.
${DAY}currentdayofthemonth
${HOUR}currenthour
${MINUTE}currentminute
${SECOND}currentsecond
${PROJECT_NAME}thenameofthecurrentproject
${PRODUCT_NAME}currentIDEname
${PROJECT_NAME}currentprojectname