PHPstorm设置注释快捷键和自定义注释内容

https://www.cnblogs.com/Steven-shi/p/8136081.html
https://www.yiichina.com/tutorial/1576
首先,PhpStorm中文件、类、函数等注释的设置在:setting-》Editor-》FIle and Code Template-》Includes下设置即可,其中方法的默认是这样的:

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

但是我发现,文件中的默认注释是这样的:

/**
 * Created by ${PRODUCT_NAME}.
 * User: ${USER}
 * Date: ${DATE}
 * Time: ${TIME}
 */

当我把上面这段中3、4、5行的代码直接复制放到PHP Function Doc Comment这个下面的时候,发现其中占位符{}中的东西并没有被替换,而是当成字符串打出来了。 方法

  1. 我们在PhpStorm中setting-》Editor-》Live Template,即找到模板选项,会看到各种语言的模板设置;

  2. 找到右边有个+号,创建一个自定义模板:选择Live Template,然后按照下图的配置顺序进行设置:[图片上传中...(image-79eb13-1558926203407-1)]

    [图片上传中...(image-81e79f-1558926203407-0)]

  3. 点保存之后,回到FIle and Code Template-》Includes,在PHP Function Doc Comment这里设置:

    /**
     * Notes:
     * User: ${USER}
     * Date: ${DATE}
     * Time: ${TIME}
    ${PARAM_DOC}
    #if (${TYPE_HINT} != "void") * @return ${TYPE_HINT}
    #end
    ${THROWS_DOC}
    */
    
    
  4. 点击Apply,点击OK,然后在方法前面,输入 /**后回车:

    /**
      * Notes:下单接口
      * User: Steven
      * Date: 2017/12/28
      * Time: 15:19
      * @return array
      * @throws \yii\db\Exception
      */
    
    

    OK,完成。

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
【社区内容提示】社区部分内容疑似由AI辅助生成,浏览时请结合常识与多方信息审慎甄别。
平台声明:文章内容(如有图片或视频亦包括在内)由作者上传并发布,文章内容仅代表作者本人观点,简书系信息发布平台,仅提供信息存储服务。

友情链接更多精彩内容