Webstorm新建JS文件、CSS文件時自動生成文件註釋

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。