WebStorm新建JS文件、CSS文件时自动生成文件注释

https://www.cnblogs.com/donghuang/archive/2020/02/11/12111527.html

WebStorm 是jetbrains公司旗下一款优秀的前端开发工具。随着如今大型项目模块愈来愈多，参与人员也愈来愈多，实际项目中常常须要明确文件用途和文件的归属，因此建立文件时添加文件注释是一种必要手段，这样便可以帮助本身和别人快速明白文件用途，又能够快速定位问题，还能够减小代码的交叉修改，避免没必要要的冲突。

settings --> Editor --> File and Code Temlates　　选择(CSS File 或 JavaScript File)

　　

　　

 

在Files内选择须要添加注释的文件类型，而后在右侧黑色文本框内输入须要的文件注释，这样就能够在新建该类型文件时，自动生成文件注释。以下两图所示：

　　

参考代码实例：

/** * @name: ${NAME} * @author: ${USER} * @date: ${DATE} ${TIME} * @description：${NAME} * @update: ${DATE} ${TIME} */

或

/** * @name: ${NAME} * @author: ${USER} * @date: ${YEAR}-${MONTH}-${DAY} ${HOUR}:${MINUTE} * @description：${NAME} * @update: ${YEAR}-${MONTH}-${DAY} ${HOUR}:${MINUTE} */

参数说明：

　　name：文件名称；

　　auther：做者(文件建立者)；

　　date：文件建立时间；

　　description：文件描述 (描述当前文件用途，JS文件还包括依赖关系)；

　　update：文件更新时间 (便于查看文件最后更新时间)；

变量说明：

　　${NAME}：当前文件 文件名称；

　　${USER}：当前系统 登陆用户名；

　　${DATE}：当前系统 设定日期格式；

　　${TIME}：当前系统 设定时间格式；

　　${YEAR}：完全年份，如 2020；

　　${MONTH}：完整月份，如 02；

　　${DAY}：完整日期，如 11；

　　${HOUR}：24小时制小时，如 16；

　　${MINUTE}：完整分钟，如 32。