VsCode插件,自動生成注釋koroFileHeader


最近正在使用vscode進行編程,為了更便利的對項目實施管理,同時利於后期維護,為一個版塊添加注釋是非常有必要的。實踐出真知,以下是對於插件koroFileHeader的簡單使用說明。

打開vscode,選擇Extensions搜索koroFileheader進行安裝

在這里插入圖片描述

在vue文件中,使用快捷鍵ctrl + Alt + i/t,可以看到當前默認設置內容

在這里插入圖片描述

根據需要修改默認設置

1.選擇File-Preferences-Settings,搜索fileheader

在這里插入圖片描述

2.修改默認設置

在這里插入圖片描述

需要注意:下面這個界面,本身里面是沒有紅框中的內容的,需要自己添加。

在這里插入圖片描述
最終修改版本:
在這里插入圖片描述

"fileheader.customMade": {    //此為頭部注釋
        "Description": "",
        "Version": "2.0",
        "Autor": "Seven",
        "Date": "Do not edit",
        "LastEditors": "Seven",
        "LastEditTime": "Do not edit"
    },
    "fileheader.cursorMode": {  //此為函數注釋
        "description":"",
        "param": "",
        "return": "",
        "author":"Seven"
 

在這里插入圖片描述
在這里插入圖片描述

注:

1.描述內容(descripition)為了便捷添加,直接設置為空;
2.這里的日期(Date)和修改時間(LastEditTime)設置,本身軟件就會自行添加和更新,所以直接寫“Do not edit”即可。
3.除日期和參數(param)外的其他內容,均可嘗試設置為漢字,方便查看。

原博:https://blog.csdn.net/SevenGirl2017/article/details/88424641


免責聲明!

本站轉載的文章為個人學習借鑒使用,本站對版權不負任何法律責任。如果侵犯了您的隱私權益,請聯系本站郵箱yoyou2525@163.com刪除。



 
粵ICP備18138465號   © 2018-2025 CODEPRJ.COM