phpstorm设置头部注释和自定义注释内容

先说设置位置:

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

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

有中文插件的话,方便点,界面是这样的

我们可以添加自定义文本内容,例如note:,也可以添加软件自带的一些变量,比如当前时间。

这里贴出变量的中文描述:

一个 PHP 函数的 PHPDoc 注释的内置模板。 它包含一个代码片段,可以在 #parse 指令的帮助下将其包含在文件模板(Templates 标签)中。 模板是可编辑的。 除了静态文本、代码和注释外,您还可以使用预定义变量,这些变量将像宏一样被扩展为相应值。 
预定义变量接收以下值:
${NAME}
 
函数名称。
${TYPE_HINT}
 
函数返回值的类型提示。 如果没有推断出返回类型,则评估为 'void'。
${PARAM_DOC}
 
形参的 PHPDoc 注释。
生成为一系列行 '* @param type name'。 如果没有形参,评估为空内容。
${THROWS_DOC}
 
异常的文档注释。
生成为一系列行 '* @throws type'。 如果没有抛出异常,评估为空内容。
${STATIC}
 
如果函数/方法是静态的,则取值为 'static',否则为空字符串。 例如: 
      #if (${STATIC} == "static") * @static      #end    
${DS}
 
美元符号,计算为普通的 “$” 字符。
${DATE}
 
当前系统日期
${TIME}
 
当前系统时间
${YEAR}
 
当前年度
${MONTH}
 
当前月份
${MONTH_NAME_SHORT}
 
当前月份名称的前 3 个字母。 例如:Jan、Feb 等
${MONTH_NAME_FULL}
 
当前月份的全名。 例如:January、February 等
${DAY}
 
当前月份的日期
${HOUR}
 
当前小时
${MINUTE}
 
当前分钟
${SECOND}
 
当前秒
${PROJECT_NAME}
 
当前项目名称
${USER}
 
当前用户
${CARET}
 
标记添加注释后文本光标必须移动到的位置。

相关推荐

  1. Spring定义注解

    2024-04-03 12:02:04       17 阅读

最近更新

  1. TCP协议是安全的吗?

    2024-04-03 12:02:04       18 阅读
  2. 阿里云服务器执行yum,一直下载docker-ce-stable失败

    2024-04-03 12:02:04       19 阅读
  3. 【Python教程】压缩PDF文件大小

    2024-04-03 12:02:04       18 阅读
  4. 通过文章id递归查询所有评论(xml)

    2024-04-03 12:02:04       20 阅读

热门阅读

  1. delegate(委托),Event(事件),Action,Func

    2024-04-03 12:02:04       14 阅读
  2. 第十四届省赛大学B组(C/C++) 冶炼金属

    2024-04-03 12:02:04       14 阅读
  3. Linux--文件、分区与挂载

    2024-04-03 12:02:04       10 阅读
  4. C语言标准库

    2024-04-03 12:02:04       16 阅读
  5. SpringMVC转发和重定向

    2024-04-03 12:02:04       14 阅读
  6. 【C++】编程规范之函数规则

    2024-04-03 12:02:04       18 阅读
  7. 深入理解WebSocket:实时双向通信的利器

    2024-04-03 12:02:04       13 阅读