PhpStorm 头部注释、类注释和函数注释的设置(稍微完善点)

举报
lxw1844912514 发表于 2022/03/27 01:00:46 2022/03/27
【摘要】 首先,PhpStorm中文件、类、函数等注释的设置在:setting-》Editor-》FIle and Code Template-》Includes下设置即可,其中方法的默认是这样的: /**${PARAM_DOC}#if (${TYPE_HINT} != "void") * @return ${TYPE_HINT...

首先,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

文章来源: blog.csdn.net,作者:lxw1844912514,版权归原作者所有,如需转载,请联系作者。

原文链接:blog.csdn.net/lxw1844912514/article/details/100028737

【版权声明】本文为华为云社区用户转载文章,如果您发现本社区中有涉嫌抄袭的内容,欢迎发送邮件进行举报,并提供相关证据,一经查实,本社区将立刻删除涉嫌侵权内容,举报邮箱: cloudbbs@huaweicloud.com
  • 点赞
  • 收藏
  • 关注作者

评论(0

0/1000
抱歉,系统识别当前为高风险访问,暂不支持该操作

全部回复

上滑加载中

设置昵称

在此一键设置昵称,即可参与社区互动!

*长度不超过10个汉字或20个英文字符,设置后3个月内不可修改。

*长度不超过10个汉字或20个英文字符,设置后3个月内不可修改。