一、效果
vscode 中可以安装 koroFileHeader 插件自动生成注释,下面介绍webstorm编辑器生成注释的两种方法。
二、操作步骤:
方法一:
使用webstorm编辑器的实时模板
1. 打开webstorm中的设置,点击编辑器
2. 选择实时模板
3. 点击右侧加号,选择实时模板
4. 输入缩写
5. 输入描述内容
6. 输入模板文本
<!-- * @Author: name * @Date: $DATE$ * @LastEditors: name * @Description: desc -->
7. 点击编辑变量
8. 输入名称和表达式,点击确定
使用方法:
输入缩写后按下tab键即可自动生成注释
缺点:
修改文件后最后一次修改人和最后一次修改时间不会自动更新,下面介绍第二种方法,可以完美解决这个问题。
方法二:
使用file watchers自动生成文件头部注释(文件内容更改后会自动修改作者和时间)
1. git clone 将项目拉下来
项目地址:github 项目地址
2. 打开 watchers.xml
将该项value中的路径替换成你电脑上app.js的绝对路径,并把$FileExt$后面的name替换成你的姓名
<option name="arguments" value="C:\Users\cinitswift\Desktop\app.js $FileDir$ $FileName$ $FileEncoding$ $FileExt$ name" />
3. 打开webstorm设置,选择工具
4. 选择File Watcher
5. 点击导入按钮,选择克隆下来的watchers.xml文件
6. 导入完成后,选中JSHeader
7. 点击编辑按钮
8. 文件类型可改为任意/vue模板等,勾选自动保存编辑的文件以触发观察程序,最后确定即可