WebStorm 中自定义文档注释模板

WebStorm 中自定义文档注释模板

前提

• 使用WebStrom写HTML，JavaScript，进行头部注释。
• 减少重复劳动
• 养成良好的代码习惯，规范化代码，规范的注释便于后续维护。

头部注释内容

• 文档描述
• 版本
• 作者
• 创建日期
• 最后修改人
• 最后修改日期

编辑注释

一、 在菜单栏 --->文档中 ---> 找到 设置。

快捷键 windows Ctrl + Alt + S

Mac command + ，

二、点击右上角 “+” --> Live Template，添加注释模板，出现以下界面，填写相关的信息。参考如下：

复制代码

/*
 * @Description: file content
 * @Version: file content
 * @Autor:
 * @Date: $date$
 * @LastEditors:
 * @LastEditTime: $date$
 */

三、 Edit variables , 时间（$date$）的具体格式，date("yyyy-MM-dd HH:mm:ss")

四、 Change 选择模板应用的范围。一般不会的就全选就好了。

五、 在新建的文件中，输入 /// + Tab 键即可 自动生成 自定义 文档头部 注释模板了!!!