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。