1. 程式人生 > >koroFileHeader 非常實用的Vscode 外掛[用於新增檔案頭部註釋]

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

koroFileHeader

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

language

一些文件

支援語言

更新日誌

常見問題

簡介

  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": {} // 函式註釋 
    

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

  • 自定義模板:

    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 ⭐️ 鼓勵一下我吧~

相關推薦

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

koroFileHeader 一個讀取使用者自定義模板,通過快捷鍵新增檔案頭部註釋、在游標處新增函式註釋的VsCode外掛 language 一些文件 支援語言 更新日誌 常見問題 簡介 檔

VsCode 新增檔案頭部註釋和函式註釋[koroFileHeader]

koroFileHeader 一個讀取使用者自定義模板,通過快捷鍵新增檔案頭部註釋、在游標處新增函式註釋的VsCode外掛 language 一些文件 支援語言 更新日誌 常見問題 簡介 檔

fileheader-vscode外掛,自動生成頭部註釋 koroFileHeader

給使用vscode的開發的小夥伴分享一個自動生成頭部註釋的外掛,使用效果如下:    生成這個註釋的快捷鍵是 ctrl+alt+i    1.安裝 在vs商店搜尋koroFileHeader &nbs

intellij idea推薦幾款非常實用外掛

intellij idea,開發利器,素以方便快捷著稱,使用者越來越多,今天介紹幾款idea中非常實用的外掛。 外掛安裝 Windows平臺上的IDEA: File > Settings > Plugins > Browse repositori

VSCode使用Remote VSCode外掛進行遠端檔案同步

寫在前面 最近在雲端申請了伺服器進行DL訓練,使用ssh的方式進行遠端的登陸,但是兩端的程式碼同步是一個比較大的問題,當然,最笨的方法可以雙端走git的方式進行,但是其實這樣也好麻煩,因此看了一下VSCode的remote edit方式,不過也踩了一些坑,特別

Pycharm 自動新增檔案註釋

File->settings->Editor->File and Code Templates->Python Script 新增以下程式碼: #!/usr/bin/env

WebStrom 設定程式碼檔案頭部註釋

webstorm->preferences..->fileTemplates  /**  * Created with Cocos2d-x3.0 jsb.  * User: ZhiJianming/[email protected]  * Date:

sublime text 3:建立可重複用的程式碼片段php檔案頭部註釋資訊快速生成

http://www.zan3.com/sublime-text-3%E5%88%9B%E5%BB%BA%E5%8F%AF%E5%A4%8D%E7%94%A8%E7%9A%84%E4%BB%A3%E7%A0%81%E7%89%87%E6%AE%B5php%E6%96%87%

Xcode 自定義檔案頭部註釋說明

背景 不知道你有沒有在使用 Xcode 建立檔案時覺得檔案頭部的註釋說明不想要或者不是自己喜歡的樣式,如果你有這個痛點,那就繼續閱讀下去哈,本文將讓你自定義檔案頭部註釋說明,告別每次建立檔案都手動修改註釋的痛。 說明: 這是 Xcode9 的一個新特性之

.NET快速資訊化系統開發框架 V3.2-&gt;Web版本新增檔案管理中心”集上傳、下載、檔案共享等一身,非常實用的功能

  檔案中心是3.2版本開始新增的一個非常實用功能,可以歸檔自己平時所需要的檔案,也可以把檔案分享給別人,更像一個知識中心。檔案中心主介面如下圖所示,左側“我的網盤”展示了使用者對檔案的分類,只能自己看到,“公共盤”中的檔案所有使用者都可以看到。選擇一個分類,右側列出了當前分類的所有檔案(第一列

.NET快速資訊化系統開發框架 V3.2->Web版本新增檔案管理中心”集上傳、下載、檔案共享等一身,非常實用的功能

  檔案中心是3.2版本開始新增的一個非常實用功能,可以歸檔自己平時所需要的檔案,也可以把檔案分享給別人,更像一個知識中心。檔案中心主介面如下圖所示,左側“我的網盤”展示了使用者對檔案的分類,只能自己看到,“公共盤”中的檔案所有使用者都可以看到。選擇一個分類,右側列出了當前分類的所有檔案(第一列會根據檔案的型

幾款非常實用的IDEA外掛

安裝外掛步驟:Preferences—>Plugins—>查詢所需外掛—>Install Settings —>Plugins—>查詢所需外掛—>Install Alibaba Java Coding Guidelines iBATIS

Vue專案開發中非常實用的圖片拖動排序外掛awe-dnd

專案中遇到一個需求; 電商管理平臺新增商品的時候需要上傳或者選擇商品輪播圖展示的圖片,這裡涉及到圖片的排序問題;一開始只能自己寫了一個點選左移或者右移的效果; 後面找到這個元件,能非常簡單的實現拖動排序的效果 安裝依賴包 npm install awe-dn

vscode中使用beautify外掛格式化vue檔案(自定義快捷鍵)

1. 先安裝外掛beautify 2.  開啟設定 => 搜尋 beautify.language  3.  配置 json 就行了   具體使用(可忽略,可不配置)  1.在工作目錄下

8個實現線上瀏覽PDF檔案實用jQuery外掛

在web開發當中我們經常需要進行需要線上瀏覽PDf內容,線上嵌入動態pdf,傳統的解決方法安裝客戶端PDF閱讀器,如果是在谷歌是可以線上瀏覽的,因為他自身就帶了一些外掛,以前遇到這樣的問題往往是費時又費力,很不好解決, 今天就給大家分享一系列使用javascript實現

wordpress免外掛實現新增“友情連結”功能,非常簡單!

【導讀】 建站這麼久以來,一直沒有弄友情連結。無耐幾個月過去了,泰泰部落格流量還是不怎麼樣,於是決定今天開始部署友情連結。 “友情連結”在wordpress站點中,一般都是通過“小工具”來插入實現的。有的主題自帶“友情連結”小工具,但也有的主題是不帶“友情連結”小工具的,

非常實用的Java檔案操作類

import java.io.BufferedInputStream; import java.io.BufferedReader; import java.io.File; import java.io.FileInputStream; import java

非常實用的Navicat啟用外掛,只需一步操作即可

首先確保你電腦上安裝了Navicat:一般只有15天試用期,到期後需要註冊啟用。通過下載下面網盤的外掛,即可一步啟用使用。外掛網盤地址:https://pan.baidu.com/s/16rJZ1ARk

Chrome有個HTTP請求報文生成外掛叫postman,這外掛在http服務介面除錯時非常實用(Mac OS安裝方法)

mac os 安裝方法 1、開啟chrome。 2、點選頂部選單  “ 視窗-->擴充套件程式 ”  就可以 開啟 外掛視窗 。 外掛視窗列出了你已經安裝過的所有外掛 (如果你有很多外掛的話 滑動視窗到最底部) 點選  獲取更多擴充套件程式  就可以開啟 chr