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

superPershing 發布于2019-08-23 12:23 / 3821人閱讀

摘要：使用文件頭部注釋在當前編輯文件中使用快捷鍵即可生成文件頭部注釋。函數注釋將光標放在函數行或者將光標放在函數上方的空白行使用快捷鍵，即可生成函數注釋。事實上，函數注釋在文件的任意位置都可生成，這里需要自己控制。

koroFileHeader

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

language

簡體中文 | English

更新日志

更新日志

常見問題

簡介

文件頭部添加注釋:

在文件開頭添加注釋，記錄文件信息

支持用戶高度自定義注釋選項

保存文件的時候，自動更新最后的編輯時間和編輯人

快捷鍵：window：ctrl+alt+i,mac：ctrl+cmd+i

在光標處添加函數注釋:

在光標處自動生成一個注釋模板，下方有栗子

支持用戶高度自定義注釋選項

快捷鍵：window：ctrl+alt+t,mac：ctrl+cmd+t

快捷鍵不可用很可能是被占用了,參考這里

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

支持注釋格式：

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

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

/*
 * @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,點擊安裝即可。

使用

文件頭部注釋：

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

函數注釋：

將光標放在函數行或者將光標放在函數上方的空白行

使用快捷鍵window：ctrl+alt+t,mac：ctrl+cmd+t，即可生成函數注釋。

事實上，函數注釋在文件的任意位置都可生成，這里需要自己控制。

注釋模板的設置

默認配置:

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

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

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

自定義模板：

在用戶設置中，搜索fileheader

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

如上設置，生成注釋：

// 文件頭部注釋
/*
 * @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

云服務器 GPU云服務器函數注釋為啥html添加注釋 java函數注釋格式 java整段添加注釋

文章版權歸作者所有，未經允許請勿轉載,若此文章存在違規行為，您可以聯系管理員刪除。

轉載請注明本文地址：http://specialneedsforspecialkids.com/yun/98439.html

koroFileHeader 非常實用的Vscode 插件[用于添加文件頭部注釋]

摘要：使用文件頭部注釋在當前編輯文件中使用快捷鍵即可生成文件頭部注釋。事實上，函數注釋在文件的任意位置都可生成，這里需要自己控制。 koroFileHeader 一個讀取用戶自定義模板，通過快捷鍵添加文件頭部注釋、在光標處添加函數注釋的VsCode插件 language 簡體中文 | English 一些文檔支持語言插件設置/配置更新日志常見問題簡介文件頭部添加注釋: 在文...

hoohack 2019-08-22 17:21 評論0 收藏0
VS code-前端配置_022

摘要：前端配置簡體中文插件，一般會自動識別你的環境，自動提示是否需要簡體中文的語言包。使用插件將目前配置保存到上，以后只需要從上獲取，就可以一次性安裝插件配置信息。 VS code-前端配置 showImg(https://segmentfault.com/img/bVbuK6l?w=1224&h=999); Chinese (Simplified) Language Pack for Vi...

cyrils 2019-08-23 18:31 評論0 收藏0
vscode常用插件【全了】

摘要：插件集待補充。。。同時，它還包含了用于轉換為格式和生成數據模式的選項用于壓縮合并和文件的應用程序。它提供了大量自定義的設置，以及自動壓縮保存并導出為文件的選項。修改文本的更多命名格式，包括駝峰命名下劃線分隔命名，命名以及命名等切換漂亮的主題插件集待補充。。。 20180903 文件【Path Intellisense】自動補全路徑瀏覽器【Open-In-Browser】在...

kyanag 2019-08-30 13:57 評論0 收藏0
vscode常用插件【全了】

摘要：插件集待補充。。。同時，它還包含了用于轉換為格式和生成數據模式的選項用于壓縮合并和文件的應用程序。它提供了大量自定義的設置，以及自動壓縮保存并導出為文件的選項。修改文本的更多命名格式，包括駝峰命名下劃線分隔命名，命名以及命名等切換漂亮的主題插件集待補充。。。 20180903 文件【Path Intellisense】自動補全路徑瀏覽器【Open-In-Browser】在...

xcc3641 2019-08-26 11:42 評論0 收藏0