PhpStorm 头部注释、类注释和函数注释的设置
PHPDoc 注释
对于文档注释,PhpStorm 提供默认启用的补全功能。将插入符号放在所需的代码结构(类、方法、函数等)之前,键入开始块注释/**,然后按⏎,PhpStorm 会创建PHPDoc 注释,根据您的选择PhpStorm 将创建所需的标签文档注释。
在 PHPDoc 注释中配置格式
在Settings/Preferences对话框->Editor->file and Code Templates ->切换到includes表单项
配置函数/方法注释
PHP Function Doc Comment
配置:点击“file and code templates->includes->PHP Function Doc Comment”,在里面输入自己想要的注释内容,注意Times对应添加的模板名称。之后点击"apply"。
使用:在项目中使用输入"/**“后点击enter键,会出现刚才添加的注释,再次点击enter键,会自动出现系统时间。
/**
* @notes:
* @author: ${USER}.chen
* @time: ${DATE} ${TIME}
* @function: ${NAME}
${PARAM_DOC}
#if (${TYPE_HINT} != "void") * @return ${TYPE_HINT}
#end
${THROWS_DOC}
*/
效果如图
配置类文件头注释
配置:点击“file and code templates->includes->PHP Class Doc Comment”,在里面输入自己想要的注释内容,注意Times对应添加的模板名称。之后点击"apply"。
/**
* Notes 文件说明
* Class ${NAME}
* Created on ${DATE} ${TIME}
* Created by ${USER}.chen
#if (${NAMESPACE}) * @package ${NAMESPACE}
#end
*/
效果如图
一键生成代码注释
在类文件中右键然后选择Generate PHPDoc blocks,然后选择要为其生成 PHPDoc 注释的代
PhpStorm 分析指定的代码结构,尽可能提取参数、返回值、变量或字段的数据,并在此基础上生成文档块的存根。
请先 后发表评论~