koroFileHeader 非常實用的Vscode 外掛[用於新增檔案頭部註釋]

OBKoro1發表於2018-05-18

koroFileHeader

一個讀取使用者自定義模板,通過快捷鍵新增檔案頭部註釋、在游標處新增函式註釋的VsCode外掛

language

簡體中文 | English

一些文件

支援語言

外掛設定/配置

更新日誌

常見問題

簡介

  1. 檔案頭部新增註釋:

    • 在檔案開頭新增註釋,記錄檔案資訊
    • 支援使用者高度自定義註釋選項
    • 儲存檔案的時候,自動更新最後的編輯時間和編輯人
    • 快捷鍵:windowctrl+alt+i,macctrl+cmd+i
  2. 在游標處新增函式註釋:

    • 在游標處自動生成一個註釋模板,下方有栗子
    • 支援使用者高度自定義註釋選項
    • 快捷鍵:windowctrl+alt+t,macctrl+cmd+t
    • 快捷鍵不可用很可能是被佔用了,參考這裡
  3. 支援不同語言的註釋格式,如下。

支援註釋格式:

  • /**/形式:Javascript/Java/go/C++/C

  • '''形式:python

  • <!-- -->形式:html

  • '形式: vba

安裝

在 Vscode 擴充套件商店中搜尋koroFileHeader,點選安裝即可。

使用

  1. 檔案頭部註釋:

    在當前編輯檔案中使用快捷鍵:windowctrl+alt+t/macctrl+cmd+t,即可生成檔案頭部註釋。

  2. 函式註釋:

    1. 將游標放在函式行或者將游標放在函式上方的空白行
    2. 使用快捷鍵windowctrl+alt+t,macctrl+cmd+t,即可生成函式註釋。
    3. 事實上,函式註釋在檔案的任意位置都可生成,這裡需要自己控制。

註釋模板的設定

  • 預設配置:

    在使用者首選項中搜尋fileheader,預設配置為:

      "fileheader.customMade": {} // 頭部註釋
      "fileheader.cursorMode": {} // 函式註釋 
    複製程式碼

    使用者未設定的情況下,頭部註釋和函式註釋模板為:

    koroFileHeader 非常實用的Vscode 外掛[用於新增檔案頭部註釋]

  • 自定義模板:

    1. 在使用者設定中,搜尋fileheader

    2. 複製預設配置+修改配置,重啟生效

      koroFileHeader 非常實用的Vscode 外掛[用於新增檔案頭部註釋]

    如上設定,生成註釋:

     // 檔案頭部註釋
     /*
      * @Description: 
      * @version: 
      * @Company: BAT
      * @Author: OBKoro1
      * @Date: 2018-10-15 20:59:57
      * @LastEditors: OBKoro1
      * @LastEditTime: 2018-10-15 20:59:57
      */
     // 函式註釋
     /**
      * @name: 
      * @test: test font
      * @msg: 
      * @param {type} 
      * @return: 
      */
    複製程式碼

自動更新最後編輯時間、編輯人:

要開啟這個功能,需要在首選項設定中填寫對應的屬性:

  "fileheader.customMade": {
    "Date": "Do not edit", // 檔案建立時間(不變)
    "LastEditors": "OBKoro1", // 檔案最後編輯者
    "LastEditTime": "Do not edit" // 檔案最後編輯時間
  }
  // 不填寫對應屬性即關閉對應功能
複製程式碼

自動更新編輯時間

示例:

koroFileHeader 非常實用的Vscode 外掛[用於新增檔案頭部註釋]

最後

如果覺得還不錯的話,就給個 Star ⭐️ 鼓勵一下我吧~

部落格前端積累文件公眾號GitHub

相關文章