VsCode 添加文件頭部註釋和函數註釋[koroFileHeader]

koroFileHeader

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

language

簡體中文 | English

更新日誌

更新日誌

常見問題

簡介

1. 文件頭部添加註釋:

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

2. 在光標處添加函數註釋:

3. • 在光標處自動生成一個註釋模板，下方有栗子
   • 支持用戶高度自定義註釋選項
   • 快捷鍵：window：ctrl+alt+t,mac：ctrl+cmd+t
   • 快捷鍵不可用極可能是被佔用了,參考這裏
1. 支持不一樣語言的註釋格式，以下。

支持註釋格式：

頭部註釋和函數註釋目前支持如下兩種形式的註釋：

/**/形式，默認狀況下將生成此類註釋：

/*
 * @Description: 
 * @Author: OBKoro1
 * @Date: 2018-08-20 00:26:26
 * @LastEditors: OBKoro1
 * @LastEditTime: 2018-11-01 10:34:14
 */

'''形式,讀取.py後綴，自動生成python形式註釋，無需配置：

'''
@Description: 
@Author: OBKoro1
@Date: 2018-10-24 21:57:52
@LastEditors: OBKoro1
@LastEditTime: 2018-11-01 10:35:54
'''

安裝

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

使用

1. 文件頭部註釋：

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

2. 函數註釋：

   1. 將光標放在函數行或者將光標放在函數上方的空白行
   2. 使用快捷鍵window：ctrl+alt+t,mac：ctrl+cmd+t，便可生成函數註釋。
   3. 事實上，函數註釋在文件的任意位置均可生成，這裏須要本身控制。

註釋模板的設置

• 默認配置:

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

  "fileheader.customMade": {} // 頭部註釋
     "fileheader.cursorMode": {} // 函數註釋

  用戶未設置的狀況下，頭部註釋和函數註釋模板爲：

  

  • 自定義模板：

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

    2. 複製默認配置+修改配置,重啓生效

       

       如上設置，生成註釋：

       // 文件頭部註釋
       /*
        * @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" // 文件最後編輯時間
  }
  // 不填寫對應屬性即關閉對應功能

自動更新編輯時間

示例:

最後

若是以爲還不錯的話，就給個 Star ⭐️ 鼓勵一下我吧~

博客、前端積累文檔、公衆號、GitHub