关键词：
主动学习
VsCode 自动生成文件头部注释和函数注释
扩展应用商店里
安装 koroFileHeader
必须的基础配置: 头部注释模板与函数注释模板
复制：复制下面给出的模板
插入：插入模板到全局设置(setting.json)中。
简单的更改：比如把名字换成自己的，不需要的字段可以删掉。
重启编辑器，使用快捷键体验它。
// 头部注释
"fileheader.customMade":
// 头部注释默认字段
"Author": "your name",
"Date": "Do not edit", // 设置后默认设置文件生成时间
"LastEditTime": "Do not edit", // 设置后，保存文件更改默认更新最后编辑时间
"LastEditors": "your name", // 设置后，保存文件更改默认更新最后编辑人
"Description": "",
"FilePath": "Do not edit", // 设置后，默认生成文件相对于项目的路径
"custom_string_obkoro1": "可以输入预定的版权声明、个性签名、空行等"
,
// 函数注释
"fileheader.cursorMode":
// 默认字段
"description":"",
"param":"",
"return":""
,
// 插件配置项
"fileheader.configObj":
"autoAdd": true, // 检测文件没有头部注释，自动添加文件头部注释
"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": true, // 新建文件自动添加头部注释
"useWorker": false, // 是否使用工作区设置
"designAddHead": false, // 添加注释图案时添加头部注释
"headDesignName": "random", // 图案注释使用哪个图案
"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": "<!--",
"middle": " * @",
"end": "-->",
,
// 默认注释 没有匹配到注释符号的时候使用。
"annotationStr":
"head": "/*",
"middle": " * @",
"end": " */",
"use": false
,
如何找到setting.json设置模板
从设置中打开
文件 > 首选项 > 设置 > 搜索fileheader >打开一个settings.json > 贴代码
快捷键使用
文件头部注释快捷键
记录文件信息/文件的传参/出参，设置个性签名、留下QQ、微信联系方式、输入空行等等
文件 > 首选项 > 键盘快捷方式，搜索 extension.cursorTip
我的window：ctrl+win+i
函数注释注释快捷键
window：ctrl+win+t
将光标放在函数行或者将光标放在函数上方的空白行。
自动解析函数参数，生成函数参数注释。
快捷键：window：ctrl+win+t,mac：ctrl+cmd+t,linux: ctrl+meta+t, Ubuntu: ctrl+super+t
多行函数参数鼠标选中后函数声明后按快捷键自动提取
鼠标左键选择多行函数声明区域，函数声明区域尽量精准
按函数注释快捷键
vscode自动生成文件注释和函数注释插件使用指南(代码片段)
Vscode自动生成文件注释和函数注释插件使用指南一、插件安装插件名：koroFileHeader插件安装二、插件配置打开配置文件添加配置配置参考：//函数注释"fileheader.cursorMode":"Function":"","Description":""... 查看详情
vscode怎么设置新建文件时头部的备注信息
...件都要在头部加上,然后保存。打开VS2013新建一个类就会自动生成带有头部模块的注释了VS2013自动添加头部注释-C#开发5更多C#开发技巧,敬请点击右侧'关注'我.参考技术A路过帮答。直接在VScode里搜索插件：vscode-fileheader还C#开... 查看详情
vscode配置
...格式化VSCode格式化laravel的blade文件2.KoroFileHeader插件配置自动生成文件头部注释和函数注释3.DocBlocker插件PHP注释 查看详情
vscode自动生成文件注释头(代码片段)
vscode-fileheader这是一个给代码文件生成头部注释的插件,每次修改文件之后会自动修改的时间和作者。最终效果图如下：生成这个注释的快捷键是ctrl+alt+i用户在settings.json中配置用户名和最后修改用户名即可使用。保存一... 查看详情
vscode如何进行代码注释定制（korofileheader）
...插入光标，快捷键ctrl+alt+t团队使用时，需要所有人都在vscode上配置一样的格式，自己的名字，这样才会有效使用。1、从注释上可以看出是谁创建，谁修改2、从注释上可以看出最后修改时间（保存时会自动更新）详细配置：koroFi... 查看详情
将vscode打造成无敌的ide自动生成文件注释头(代码片段)
vscode-fileheader这是一个给代码文件生成头部注释的插件。最终效果图如下：生成这个注释的快捷键是ctrl+alt+i用户在settings.json中配置用户名和最后修改用户名即可使用。保存一下，重启vscode即可使用。对既定模板不... 查看详情
用doxygen风格注释代码生成文档(代码片段)
...码同步起来。要注意文档的规范性，所以可以采用doxygen自动生成文档。下面通过操作对文档的注释进行一下总结。2.具体操作因为我们用的vscode的，可以下载DoxygenDocumentationGenerator插件。当安装上插件后可以进行使用了。2.1生成... 查看详情
go-注释
...程度Go-注释内容 1. 包注释，位于某个包下Go程序文件的顶部 2. 函数注释，位于Go函数的头部 3. 代码行注释，位于注释代码行的头部Go-注释形式 1. 单行注释 // 2. 多行注释 /**/... 查看详情
eclipse中在函数头部添加说明性注释和参数的注释，该用啥快捷键
eclipse中在函数头部添加说明性注释和参数的注释，该用什么快捷键，查过很网站，都是说ctrl+/和ctrl+shift+/这两种注释方式，都没有对方法说明性注释的快捷键么？1）你在方法前输入/**然后一回车，自动帮你生成方法和参数的注... 查看详情
vscode必备配置(代码片段)
...2.代码格式化与错误检查3.关于有时候无法查看代码定义vscode使用的是有一定要注意：不要有中文路径，不要有中文路径，不要有中文路径！！！1.自动化注释工具我用过的比较不错的注释工具koroFileHeader头... 查看详情
unity脚本自动添加头部注释(代码片段)
Unity脚本自动添加头部注释就是创建.cs文件时自动添加作者名，创建时间，文件名等看示例，我们在Unity的project面板下先创建一个Scripts文件夹，然后在Scripts文件夹下创建一个脚本，命名为：Test.cs然后就是... 查看详情
unity脚本自动添加头部注释(代码片段)
Unity脚本自动添加头部注释就是创建.cs文件时自动添加作者名，创建时间，文件名等看示例，我们在Unity的project面板下先创建一个Scripts文件夹，然后在Scripts文件夹下创建一个脚本，命名为：Test.cs然后就是... 查看详情
unity脚本自动添加头部注释(代码片段)
Unity脚本自动添加头部注释就是创建.cs文件时自动添加作者名，创建时间，文件名等看示例，我们在Unity的project面板下先创建一个Scripts文件夹，然后在Scripts文件夹下创建一个脚本，命名为：Test.cs然后就是... 查看详情
vscode配置快速输入函数注释(代码片段)
1、进入vscode选择文件，首选项下的用户代码片段2、弹出框输入Python后回车3、弹出文件（python.json）输入如下内容，原有内容不要修改或者删除，加入funciton部分"HEADER":"prefix":"h 查看详情
vscode配置快速输入函数注释(代码片段)
1、进入vscode选择文件，首选项下的用户代码片段2、弹出框输入Python后回车3、弹出文件（python.json）输入如下内容，原有内容不要修改或者删除，加入funciton部分"HEADER":"prefix":"h 查看详情
androidstudio新建类头部注释和添加函数注释模板及快捷键(代码片段)
一，AndroidStudio新建类头部注释是不是有时候看到这个很心烦其实Studio中有设置修改这些注释模板的信息的功能其实很简单，只需要两步：1.打开Setting设置面板，找到FileandCodeTemplates，选择Includes下的FileHeader2.修... 查看详情
python文件头部规范注释与省略内容杂记(代码片段)
文件头部规范Python相关文档（官方文档）：2.Python解释器—Python3.11.2文档第一行（可选）：#!/usr/bin/python、#!/usr/bin/python3、#!/usr/bin/envpython、#!/usr/bin/envpython3；通常，以“#!”开头的代码行叫做Shebang，用于指定Linux、macOS等系统运... 查看详情
关于sublime自动生成头部注释
1.在tool->newsnippet…创建一个新的snippet sublimetext2用snippet创建文件头部信息Snippetsaresmarttemplatesthatwillinserttextforyouandadaptittotheircontext.Snippet是插入到文本中的智能模板并使这段文本适当当前代码环境.程序员总是会不断的重写一... 查看详情