WebStorm 中自定义项目的文档注释

前提

1、用WebStrom不管写HTML，还是JavaScript都会涉及到一些文档说明。尤其是文档的头部注解说明。
2、只要是你写的页面，头部注解说明基本一致。每次都写一遍？这不像是一个玩计算机人的风格。
3、下面的方法。就解决了此问题。
4、同时提示：养成良好的代码习惯，规范化代码，规范的注释便于后续维护。

实现效果

自定义模板开始

1、菜单栏===>settings

或者直接 快捷键 Ctrl + Alt + S 打开Webstorm设置，找不到的 可以 直接搜索 ‘Live Template’，然后选择进入到右侧菜单，如下：

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

<!--
@name: 
@description: 
@author: byx
@time: $date$
-->

详细信息图如下：
　第五步，“Edit variables” ,这里说一下，时间（$date$）的具体格式，这个格式和 java中的还不一样，百度也是一半对，一半错，记录下来。防止下回换电脑再应用到。

date(“yyyy-MM-dd HH:mm:ss”)

第六步，“Change” 选择模板应用的范围。一般不会的就全选就好了。嘿嘿。我只HTML中用到此快捷键。就只勾选了HTML相关。

选择模板应用范围项 为必选项，不选 会报错。保存不了。

3、在HTML代码中，输入 /// + Tab 键即可 自动生成 自定的 文档头部 注释模板了!!!

参考