idea注釋模板

進入配置項

File>Setting>Live Templates

新建（注釋）模板組

點擊右側的+號，選擇Template Group
名字隨意，如：myTemp

新建（注釋）模板

選中myTemp組，再次點擊右側的+號。選擇live Template

創建類的（注釋）模板

abbreviation處填寫class
template text處填寫如下代碼(author改為自己的名字)：

/**
 * xxx類
 * @author 丁少華
 * @date $date$ $time$
 */

$xxx$是變量xxx的意思，需要對其配置，點擊右側的 varibles按鈕對其配置
date的Express配置為date()
time的Express配置為time()
點擊template text下方的提示，No applicable context. Define，下拉選擇JavaScript and Typescript

創建vue組件（注釋）模板

vue組件也是一個類，跟上邊類注釋差不多，只不過需要標明繼承至vue
abbreviation處填寫vc（vue compnebts的簡寫）
template text處填寫如下代碼(author改為自己的名字)：

/**
 * xxx組件
 * @author 丁少華
 * @date $date$ $time$
 * @extends Vue
 */

創建方法的（注釋）模板

abbreviation處填寫fn
template text處填寫如下代碼：

 /**
  * 用於xxx
  * @param {string} uid - 用戶id
  * @return {User}一個用戶
  */

創建屬性的（注釋）模板

屬性就不用模板了。單行注釋就行，說清楚這個屬性用於做什么

其他

@throws：如果類或者方法可能拋出異常，要用此標簽
@module: 到處模塊請看此處

使用方法

輸入剛才定義的abbreviation，按下tab，即可。

jsDoc文檔

利用jsDoc規范來注釋代碼，能快速生成對應的文檔
jsDoc使用方法和說名，參考此處

如果你使用的工具是vscode

那么只需要按下ctrl+shfit+p，輸入snippets。
創建或者找到javascript.json或typescript.json，回車，進入其配置文件編輯界面。
在文件輸入類似以下內容即可：

{
  "Print to js class": {
    "prefix": "vc",
    "body": [
        "/*",
        " *@description: $0",
        " *@author:  丁少華",
        " *@date: ${CURRENT_YEAR}-${CURRENT_MONTH}-${CURRENT_DATE} ${CURRENT_HOUR}:${CURRENT_MINUTE}:${CURRENT_SECOND}",
        " */"
    ]
  }
}

使用跟idea一樣