vscode自动添加备注及函数信息

由于工作原因,使用过一段时间的c#,发现c#是具有自动添加函数备注信息的,就想查查vscode能否完成这个功能,经过一段时间的查找资料和研究,将完成的过程写下来,分享以下.

1.下载插件

首先先下载插件koroFileHeader,在vscode中在线下载.

在vscode中插件安装界面直接输入插件名称就可以看到了.大概简介如下:

简介 VSCode插件: 用于一键生成文件头部注释并自动更新最后编辑人和编辑时间、函数注释自动生成和参数提取。插件可以帮助用户养成良好的编码习惯，规范整个团队风格。从2018年5月维护至今, 关闭issue 300+ ，拥有250K+的用户，VSCode图表统计日安装用户100多-400多人，经过多版迭代后，插件支持所有主流语言,灵活方便，文档齐全，食用简单！觉得插件不错的话，就给个Star??吧~主要功能 自动生成文件头部注释php注释，自动更新最后编辑人、最后编辑时间等。一键生成函数注释，支持函数参数自动提取并列到注释中。支持添加佛祖保佑永无bug、神兽护体、甩葱少女等好玩有趣的图像注释配置非常灵活方便，各种细节都能配置，可以量身打造适合你的注释。支持所有主流语言, 配置文档非常详细，齐全。

直接选择安装就ok了.

2.环境配置

单击设置按钮,在设置界面打开settings.json(如果没有找到,可以使用快捷键ctrl+shift+p,然后输入setting.json,就可以找到),编辑如下图

{ // 头部注释

"fileheader.customMade": {

// 头部注释默认字段

"Author": "Yu Fu Chang",

"Date": "Do not edit", // 设置后默认设置文件生成时间

"LastEditTime": "Do not edit", // 设置后，保存文件更改默认更新最后编辑时间

"LastEditors": "Yu Fu Chang", // 设置后，保存文件更改默认更新最后编辑人

"Description": "在此处添加描述",

"FilePath": "Do not edit", // 设置后，默认生成文件相对于项目的路径

"custom_string_obkoro1": "个性签名"

},

// 函数注释

"fileheader.cursorMode": {

// 默认字段

"description":"",

"param":"",

"return":""

},

// 插件配置项

"fileheader.configObj": {

"autoAdd": false, // 检测文件没有头部注释，自动添加文件头部注释

"autoAddLine": 100, // 文件超过多少行数 不再自动添加头部注释

"autoAlready": true, // 只添加插件支持的语言以及用户通过`language`选项自定义的注释

"supportAutoLanguage": [], // 设置之后，在数组内的文件才支持自动添加

// 自动添加头部注释黑名单

"prohibitAutoAdd": [

"json"

],

"prohibitItemAutoAdd": [ "项目的全称禁止项目自动添加头部注释, 使用快捷键自行添加" ],

"folderBlacklist": [ "node_modules" ], // 文件夹或文件名禁止自动添加头部注释

"wideSame": false, // 头部注释等宽设置

"wideNum": 13, // 头部注释字段长度 默认为13

"functionWideNum": 0, // 函数注释等宽设置 设为0 即为关闭

// 头部注释第几行插入

"headInsertLine": {

"php": 2 // php文件 插入到第二行

},

"beforeAnnotation": {}, // 头部注释之前插入内容

"afterAnnotation": {}, // 头部注释之后插入内容

"specialOptions": {}, // 特殊字段自定义

"switch": {

"newlineAddAnnotation": true // 默认遇到换行符(\r\n \n \r)添加注释符号

},

"moveCursor": true, // 自动移动光标到Description所在行

"dateFormat": "YYYY-MM-DD HH:mm:ss",

"atSymbol": ["@", "@"], // 更改所有文件的自定义注释中的@符号

"atSymbolObj": {}, // 更改单独语言/文件的@

"colon": [": ", ": "], // 更改所有文件的注释冒号

"colonObj": {}, // 更改单独语言/文件的冒号

"filePathColon": "路径分隔符替换", // 默认值： mac: / window是: \

"showErrorMessage": false, // 是否显示插件错误通知 用于debugger

"writeLog": false, // 错误日志生成

"CheckFileChange": false, // 单个文件保存时进行diff检查

"createHeader": false, // 新建文件自动添加头部注释

"useWorker": false, // 是否使用工作区设置

"designAddHead": true, // 添加注释图案时添加头部注释

"headDesignName": "belle", // 图案注释使用哪个图案

/*

'random', // 随机

'buddhalImg', // 佛祖

'buddhalImgSay', // 佛祖+佛曰

'buddhalSay', // 佛曰

'totemDragon', // 龙图腾

'belle', // 美女

'coderSong', // 程序员之歌

'loitumaGirl', // 甩葱少女

'keyboardAll', // 全键盘

'keyboardSmall', // 小键盘

'totemWestDragon', // 喷火龙

'jesus', // 耶稣

'dog', // 狗

'grassHorse', // 草泥马

'grassHorse2', // 草泥马2

'totemBat', // 蝙蝠

'',// 空

*/

"headDesign": false, // 是否使用图案注释替换头部注释

// 自定义配置是否在函数内生成注释 不同文件类型和语言类型

"cursorModeInternalAll": {}, // 默认为false 在函数外生成函数注释

"openFunctionParamsCheck": true, // 开启关闭自动提取添加函数参数

"functionParamsShape": ["{", "}"], // 函数参数外形自定义

// "functionParamsShape": "no type" 函数参数不需要类型

"functionBlankSpaceAll": {}, // 函数注释空格缩进 默认为空对象 默认值为0 不缩进

"functionTypeSymbol": "*", // 参数没有类型时的默认值

"typeParamOrder": "type param", // 参数类型 和 参数的位置自定义

// 自定义语言注释，自定义取消 head、end 部分

// 不设置自定义配置language无效 默认都有head、end

"customHasHeadEnd": {}, // "cancel head and function" | "cancel head" | "cancel function"

"throttleTime": 60000, // 对同一个文件 需要过1分钟再次修改文件并保存才会更新注释

// 自定义语言注释符号，覆盖插件的注释格式

"language": {

// js后缀文件

"js": {

"head": "/$$",

"middle": " $ @",

"end": " $/",

// 函数自定义注释符号：如果有此配置 会默认使用

"functionSymbol": {

"head": "/******* ", // 统一增加几个*号

"middle": " * @",

"end": " */"

},

"functionParams": "typescript" // 函数注释使用ts语言的解析逻辑

},

// 一次匹配多种文件后缀文件 不用重复设置

"h/hpp/cpp": {

"head": "/*** ", // 统一增加几个*号

"middle": " * @",

"end": " */"

},

// 针对有特殊要求的文件如：test.blade.php

"blade.php":{

"head": "",

}

},

// 默认注释 没有匹配到注释符号的时候使用。

"annotationStr": {

"head": "/*",

"middle": " * @",

"end": " */",

"use": false

},

},

"files.associations": {

"adc.h": "c"

},

"code-runner.ignoreSelection": true,

"code-runner.runInTerminal": true,

"code-runner.saveFileBeforeRun": true,

"debug.onTaskErrors": "debugAnyway",

"explorer.confirmDragAndDrop": false

}

保存,设置完成

3.使用

我们打开一个文件,

可以使用快捷键ctrl+win+I添加文件的整体备注.如下图

可以使用快捷键对函数进行添加备注.如下图

怎么样,这样是不是方便很多,并且生成的备注还是有标准的,更整齐统一.

（编辑：晋中站长网）

【声明】本站内容均来自网络，其相关言论仅代表作者个人观点，不代表本站立场。若无意侵犯到您的权利，请及时与联系站长删除相关内容!