Vscode 函数注释插件koroFileHeader

原创 已于 2023-03-08 20:32:47 修改 · 1.6k 阅读 · 8 ·
CC 4.0 BY-SA版权
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
文章标签：

#vscode #ide #编辑器

于 2023-03-03 11:45:11 首次发布
文章介绍了在VSCode中安装和配置koroFileHeader插件来增强代码注释的习惯，通过快捷键ctrl+win+t生成函数注释模板，提高代码的可读性和函数的文档功能。

在开发过程中，随手写注释是一个好习惯，若干年后重新看代码才能快速了解某函数的功能，提高代码可读性，以下是koroFileHeader在vscode的安装及使用，在此记录一下

一、搜索安装koroFileHeader

在这里插入图片描述

二、打开配置项

进入方式1：
在这里插入图片描述
进入方式2：
在这里插入图片描述

三、在setting搜索fileheader，打开配置项Cursor Mode

在这里插入图片描述

四、添加配置项

更多配置选项查看github
在这里插入图片描述

    "fileheader.cursorMode": { // 函数配置项
        "description": "", // 功能描述
        "param": "", // 传入参数
        "return": "", // 返回结果
    },

五、使用

写好函数之后，在函数名使用快捷键ctrl+win+t，生成函数说明模板并添加相关函数内容
在这里插入图片描述
如果不想生成头部注释，可以进行如下配置
在这里插入图片描述

六、效果

在调用该函数时，鼠标移到函数名，会显示相关函数说明
在这里插入图片描述

vscode自动添加备注及函数信息
sixtome
11-07 2432
vscode ,自动注释
在VSCode使用koroFileHeader自动生成Python代码的头注释与函数注释
木头大左的博客
12-10 815
头注释快捷键Ctrl+Win+I函数注释快捷键Ctrl+Win+T。
干货|关于React项目在vscode中如何配置显示头部注释（koroFileHeader插件结合settings.json）
m0_61998604的博客
10-23 1275
如果想要修改注释模板，可以在文件中进一步定制。你可以在中修改注释的结构。这样，VSCode 会根据你保存文件的时间自动更新相关信息，确保每次修改的时间记录准确。
代码注释自动化：awesome-vscode文档生成插件推荐
最新发布
gitblog_01122的博客
10-07 694
你是否还在为手动编写代码注释耗费大量时间？是否因团队注释风格不统一而头疼？本文将推荐3款能自动生成代码注释的VSCode插件，帮助你5分钟内完成原本需要1小时的文档工作，让代码注释从负担变成开发助力。 ## 为什么需要注释自动化工具 代码注释是软件开发中不可或缺的部分，但手动编写注释存在三大痛点：耗时费力、格式混乱、更新滞后。根据Stack Overflow 2024年开发者调查，73%的开发...
工具 | VS Code 使用技巧
I_feige的博客
09-15 2万+
本文总结了Visual Studio Code的一些实用技巧，包括：1）通过快捷键或菜单查看文件函数列表；2）使用不同方法搜索工程/文件中的字符串；3）快速搜索工程文件；4）插件安装与推荐（如Git管理、C/C++开发等）；5）查看Git修改历史和PlantUML预览；6）列编辑操作；7）常见问题处理。文末还列出了常用快捷键和C语言开发推荐插件，帮助提升编码效率。
vscode 注释插件
good god~的博客
06-15 8351
vscode 注释插件
【工具】vscode的常用插件之注释插件
热门推荐
一介草民，只为生活。
05-23 2万+
本文整理了vscode常用插件之注释插件。
vscode扩展应用 -koroFileHeader（jsdoc代码风格注释）
qq_55961367的博客
08-13 477
这篇配置文档详细介绍了VS Code编辑器的各项设置参数，主要包括：1) ESLint配置，支持多种文件类型验证；2) 编辑器基础设置，如字体、缩放等；3) Vetur插件对Vue文件的格式化支持；4) 文件头部注释自动生成功能，包含创建时间、作者等元数据；5) 远程SSH连接配置；6) Vue开发辅助设置。文档特别强调了文件头部注释的自定义选项，包括时间格式、符号样式等，并提供了快捷键操作说明。整体配置覆盖了前端开发中的代码规范检查、格式化、注释管理等核心需求。
工具-VsCode插件koroFileHeader
算法攻城狮
09-06 1148
VsCode插件koroFileHeader设置文件头注释和函数注释 在线安装 离线安装 本文档讲离线安装 第一步：下载https://github.com/OBKoro1/koro1FileHeader/wiki/%E9%85%8D%E7%BD%AE 第二步：2.文件->首选项->设置->搜索fileheader->settings.json编辑 { "fileheader.Author": "lishuwei", // 插件配置选项,readme:https:/
VsCode 使用 koroFileHeader 配置作者信息、及函数注释
ericdowney
10-08 2822
在vscode中打开 首选项 > 设置 > 搜索。> 在右侧中贴上配置 > 做简单的更改。在 Vscode 扩展商店中搜索。
vscode代码注释器配置
m0_60827485的博客
06-21 1655
1、在vscode插件中安装koroFileHeader。文件头注释添加特殊图案：ctrl+win+j。打开用户名的setting,json即可。3、修改完后直接重启vscode开始生效。2、快捷键打开setting.json。函数注释中参数切换：ctrl+win+y。文件头注释添加：ctrl+win+i。函数头注释添加：ctrl+win+t。
VSCode安装模板文件注释、模板函数注释的插件
Cq1123581321的博客
04-07 794
安装KoroFileHeader插件。
vscode用于生成文件头部注释和函数注释的插件，支持所有主流语言,功能强大，灵活方便，文档齐全，食用简单！
weixin_43869518的博客
10-01 502
用于生成文件头部注释和函数注释的插件，支持所有主流语言,功能强大，灵活方便，文档齐全，食用简单！
vscode注释插件「koroFileHeader」
WXY19990803的博客
11-28 4228
在上面的插件中我选择做推荐，原因一是使用人数比较多（最多的是 Better Comments ），二是它能做文件头部注释和函数注释，注释模块可配置。头部注释可自动更新最后编辑人。
vscode自动添加函数注释头插件使用方法
kevin1499的博客
11-22 2113
本文详细介绍了vscode自动添加函数注释头插件的使用方法。
Vscode自动生成文件注释和函数注释插件使用指南
旧年不在的博客
07-07 3796
Vscode自动生成文件注释和函数注释插件使用指南
【VSCode注释插件：koroFileHeader】
小码屋
06-20 2242
代码注释是程序设计者与程序阅读者之间通信的重要手段。应用注释规范对于软件本身和软件开发人员而言尤为重要。在团队中引入注释工具，统一注释格式，方便快捷编写注释显得更加重要。对于vscode的项目我们推荐使用koroFileHeader插件。用于生成文件头部注释和函数注释的插件，支持所有主流语言,功能强大，灵活方便，文档齐全，食用简单！在 Vscode 扩展商店中搜索koroFileHeader, 点击安装。（1）查找配置文件setting.json： vscode工具栏→code→首选项→设置→搜索setti
VSCode比较好用的注释插件
jagger_guo的博客
03-08 2万+
1. 在扩展栏搜索插件安装： 2. 在vsCode的首选项的用户设置添加，如下自定义的文件头： "fileheader.customMade": { "Author": "g05047", "Date": "Do not edit", "LastEditors": "g05047", "LastEditTime": ...
vscode的函数注释插件]
12-06
以下是介绍VSCode中的函数注释插件koroFileHeader的方法： 1. 首先，需要在VSCode中安装koroFileHeader插件。可以在VSCode的扩展商店中搜索koroFileHeader，然后点击安装即可。 2. 安装完成后，在需要添加函数注释的函数上方输入“/**”，然后按下回车键，即可自动生成函数注释。 3. 自动生成的函数注释包括函数的参数、返回值、函数说明等信息，可以根据需要进行修改。 4. 如果需要添加文件头部注释，可以在文件开头输入“/**”，然后按下回车键，即可自动生成文件头部注释。 5. 自动生成的文件头部注释包括文件名、作者、创建时间等信息，也可以根据需要进行修改。 6. koroFileHeader插件支持多种语言，包括JavaScript、Python、Java等，可以根据需要进行设置。 示例代码如下： ```python def add(a, b): """ This function adds two numbers. Parameters: a (int): The first number. b (int): The second number. Returns: int: The sum of a and b. """ return a + b ```
评论 1
成就一亿技术人!
拼手气红包6.0元
还能输入1000个字符
 
红包 添加红包
表情包 插入表情
表情包 代码片
 条评论被折叠 查看
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值