一個讀取用戶自定義模板，通過快捷鍵添加文件頭部注釋、在光標處添加函數(shù)注釋的VsCode插件

簡介

1. 文件頭部添加注釋:

   • 在文件開頭添加注釋，記錄文件信息
   • 支持用戶高度自定義注釋選項
   • 保存文件的時候，自動更新最后的編輯時間和編輯人
   • 快捷鍵：window：ctrl+alt+i,mac：ctrl+cmd+i

2. 在光標處添加函數(shù)注釋:

   • 在光標處自動生成一個注釋模板，下方有栗子
   • 支持用戶高度自定義注釋選項
   • 快捷鍵：window：ctrl+alt+t,mac：ctrl+cmd+t
   • 快捷鍵不可用很可能是被占用了,參考這里

3. 支持不同語言的注釋格式，如下。

支持注釋格式：

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

• '''形式：python

• ``形式：html

• '形式： vba

安裝

在 Vscode 擴展商店中搜索koroFileHeader,點擊安裝即可。

使用

1. 文件頭部注釋：

   在當前編輯文件中使用快捷鍵:window：ctrl+alt+t/mac：ctrl+cmd+t,即可生成文件頭部注釋。

2. 函數(shù)注釋：

   1. 將光標放在函數(shù)行或者將光標放在函數(shù)上方的空白行
   2. 使用快捷鍵window：ctrl+alt+t,mac：ctrl+cmd+t，即可生成函數(shù)注釋。
   3. 事實上，函數(shù)注釋在文件的任意位置都可生成，這里需要自己控制。

注釋模板的設置

• 默認配置:

  在用戶首選項中搜索fileheader，默認配置為：

    "fileheader.customMade": {} // 頭部注釋
    "fileheader.cursorMode": {} // 函數(shù)注釋 
  復制代碼
  

  用戶未設置的情況下，頭部注釋和函數(shù)注釋模板為：

  image

  <figcaption style="display: block; text-align: center; font-size: 1rem; line-height: 1.6; color: rgb(144, 144, 144); margin-top: 2px;"></figcaption>

• 自定義模板：

  1. 在用戶設置中，搜索fileheader

  2. 復制默認配置+修改配置,重啟生效

     [圖片上傳失敗...(image-9a3f56-1586483121967)]

     <figcaption style="display: block; text-align: center; font-size: 1rem; line-height: 1.6; color: rgb(144, 144, 144); margin-top: 2px;"></figcaption>

  如上設置，生成注釋：

   // 文件頭部注釋
   /*
    * @Description: 
    * @version: 
    * @Company: BAT
    * @Author: OBKoro1
    * @Date: 2018-10-15 20:59:57
    * @LastEditors: OBKoro1
    * @LastEditTime: 2018-10-15 20:59:57
    */
   // 函數(shù)注釋
   /**
    * @name: 
    * @test: test font
    * @msg: 
    * @param {type} 
    * @return: 
    */
  復制代碼
  

自動更新最后編輯時間、編輯人：

要開啟這個功能，需要在首選項設置中填寫對應的屬性：

  "fileheader.customMade": {
    "Date": "Do not edit", // 文件創(chuàng)建時間(不變)
    "LastEditors": "OBKoro1", // 文件最后編輯者
    "LastEditTime": "Do not edit" // 文件最后編輯時間
  }
  // 不填寫對應屬性即關(guān)閉對應功能
復制代碼

自動更新編輯時間

示例:

image