VScode实现文件、函数自动添加注释说明信息

这篇具有很好参考价值的文章主要介绍了VScode实现文件、函数自动添加注释说明信息。希望对大家有所帮助。如果存在错误或未考虑完全的地方,请大家不吝赐教,您也可以点击"举报违法"按钮提交疑问。

常规的手动注释费时费力,不方便,拖慢开发进度,甚至影响开发者心情,因此需要实现自动注释,不仅能减少工作量,也能让编写的代码更加的规范整洁,易于理解。

在VScode的插件搜索栏中,查找并下载koroFileHeader插件。

vscode给函数添加注释说明,开发工具经验教程,vscode,ide,编辑器,c++,java,python,c语言

koroFileHeader插件可以帮助快速实现,记录文件信息/文件的传参/出参,设置个性签名、留下QQ、微信联系方式、输入空行等等,非常的简单方便。

支持用户高度自定义注释选项, 适配各种需求的注释形式。

并且保存文件的时候,会自动更新最后的编辑时间和编辑人信息。

头文件注释快捷键:

window:ctrl+win+i

mac:     ctrl+cmd+i

linux:       ctrl+meta+i

Ubuntu:   ctrl+super+i

在插件安装完成并配置后,输入如下所示的快捷键,既可以实现如图所示的自动注释功能。

文件头部注释快捷键:crtl+alt+i(window),ctrl+cmd+t (mac)

vscode给函数添加注释说明,开发工具经验教程,vscode,ide,编辑器,c++,java,python,c语言

函数注释快捷键:ctrl+alt+t (window), ctrl+alt+t(mac)

vscode给函数添加注释说明,开发工具经验教程,vscode,ide,编辑器,c++,java,python,c语言

打开vscode的设置setting.json

提示:新安装插件后,查看设置可能找不到此插件,重启VScode软件后,即可以正常操作。

vscode给函数添加注释说明,开发工具经验教程,vscode,ide,编辑器,c++,java,python,c语言

点开对应的功能区,填入对应的注释功能json代码

vscode给函数添加注释说明,开发工具经验教程,vscode,ide,编辑器,c++,java,python,c语言

点击头部注释,在settings.json中加上如下代码

    //头部注释
    "fileheader.customMade": {
        // Author字段是文件的创建者 可以在specialOptions中更改特殊属性
        // 公司项目和个人项目可以配置不同的用户名与邮箱 搜索: gitconfig includeIf  比如: https://ayase.moe/2021/03/09/customized-git-config/
        // 自动提取当前git config中的: 用户名、邮箱
        //"Author": "git config user.name && git config user.email", // 同时获取用户名与邮箱
        // "Author": "git config user.name", // 仅获取用户名
        // "Author": "git config user.email", // 仅获取邮箱
        "Author": "fang", // 写死的固定值 不从git config中获取
        "Date": "Do not edit", // 文件创建时间(不变)
        // LastEditors、LastEditTime、FilePath将会自动更新 如果觉得时间更新的太频繁可以使用throttleTime(默认为1分钟)配置更改更新时间。
        //"LastEditors": "git config user.name && git config user.email", // 文件最后编辑者 与Author字段一致
        "LastEditors": "fang",
        // 由于编辑文件就会变更最后编辑时间,多人协作中合并的时候会导致merge
        // 可以将时间颗粒度改为周、或者月,这样冲突就减少很多。搜索变更时间格式: dateFormat
        "LastEditTime": "Do not edit", // 文件最后编辑时间
        // 输出相对路径,类似: /文件夹名称/src/index.js
        "FilePath": "Do not edit", // 文件在项目中的相对路径 自动更新
        // 插件会自动将光标移动到Description选项中 方便输入 Description字段可以在specialOptions更改
        "Description": "", // 介绍文件的作用、文件的入参、出参。
        // custom_string_obkoro1~custom_string_obkoro100都可以输出自定义信息
        // 可以设置多条自定义信息 设置个性签名、留下QQ、微信联系方式、输入空行等
        "custom_string_obkoro1": "", 
        // 版权声明 保留文件所有权利 自动替换年份 获取git配置的用户名和邮箱
        // 版权声明获取git配置, 与Author字段一致: ${git_name} ${git_email} ${git_name_email}
        "custom_string_obkoro1_copyright": "Copyright (c) ${now_year} by ${git_name_email}, All Rights Reserved. "
        // "custom_string_obkoro1_copyright": "Copyright (c) ${now_year} by 写死的公司名/用户名, All Rights Reserved. "
    }

点击设置函数注释,在settings.json中加上如下代码

// 函数注释
"fileheader.cursorMode": {
    "description": "", // 函数注释生成之后,光标移动到这里
    "param": "", // param 开启函数参数自动提取 需要将光标放在函数行或者函数上方的空白行
    "return": "",
}

添加后,具体如下

vscode给函数添加注释说明,开发工具经验教程,vscode,ide,编辑器,c++,java,python,c语言

重启VScode,即可以正常使用。

本文为个人使用记录笔记,写的不是很详细,koroFileHeader插件官方说明链接如下: 安装和快速上手 · OBKoro1/koro1FileHeader Wiki (github.com)https://github.com/OBKoro1/koro1FileHeader/wiki/%E5%AE%89%E8%A3%85%E5%92%8C%E5%BF%AB%E9%80%9F%E4%B8%8A%E6%89%8B文章来源地址https://www.toymoban.com/news/detail-845574.html

到了这里,关于VScode实现文件、函数自动添加注释说明信息的文章就介绍完了。如果您还想了解更多内容,请在右上角搜索TOY模板网以前的文章或继续浏览下面的相关文章,希望大家以后多多支持TOY模板网!

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处: 如若内容造成侵权/违法违规/事实不符,请点击违法举报进行投诉反馈,一经查实,立即删除!

领支付宝红包 赞助服务器费用

相关文章

  • VSCode中自动生成文档头注释和函数注释

    在编写python代码的时候,有时候需要对函数的作用、参数以及返回值进行说明,如下图所示,自己编写的话会有很多重复操作,于是希望可以使用快捷键自己生成,下面进行具体步骤的讲解。 打开VSCode,在扩展中搜索koroFileHeader,进行安装 1.在VSCode中打开设置 2.在设置中添加

    2024年02月08日
    浏览(55)
  • 最新的Microsoft Visual Studio新建文件自动添加注释教程

    提示:文章写完后,目录可以自动生成,如何生成可参考右边的帮助文档 目录 前言 一、注释是什么? 二、自动添加头部注释 1.添加注释教程 第一步:找到VS安装的路径,忘记了就点击VS图标,右键属性找到起始位置。  第二步:在安装路径下继续往下找一个叫Class.cs的文件

    2024年02月04日
    浏览(81)
  • 在 C 语言中添加注释、包含头文件和使用 printf 函数输出字符串的方法

    注释是程序员在编写代码时添加给自己或其他人的说明文字,用来提高代码的可读性,方便理解。注释通常会添加在代码的关键部分以及不易理解的地方。 在C语言中,注释可以使用两种方式:单行注释以及多行注释。单行注释使用\\\"//\\\",多行注释使用\\\"/* */\\\"。多行注释不可嵌套

    2023年04月22日
    浏览(53)
  • pycharm创建py文件时自动添加基础信息--模板

    在图片中加入下面基本信息,这些基本信息可以自己定义:

    2024年02月09日
    浏览(37)
  • MySQL如何查看添加修改表以及字段注释信息

    MySQL数据库中,如何查看表和字段的注释信息,以及如何添加,修改表和字段的注释信息呢?这里简单总结归纳一下。仅供参考。 方法1:创建表的时候添加表的注释信息 方法2:使用ALTER TABLE给表添加注释 如果修改表的注释信息,只能使用上面的方法2. 方法1:查看表的创建脚

    2024年03月09日
    浏览(56)
  • Goland 注释时自动在注释符号后添加空格

    不得不说 JetBrains 旗下的 IDE 都好用,而且对于注释这块,使用 Ctrl + / 进行注释的时候,大多会在每个注释符号后统一添加一个空格,比如 PyCharm 和 RubeMine 等。 但最近终于碰到了一个例外,那就是 GoLand,你进行行注释的时候,它默认是不会加空格的,就像下边这种(至于它

    2024年02月12日
    浏览(39)
  • Pycharm工具Python开发自动添加注释(详细)

    定义了一个函数,在函数下面敲入了三个双引号后,enter回车并没有自动出现注释,如图: 解决办法 Pycharm中依次打开File — Settings — Tools — Python Integrated Tools,如图: 成功

    2024年02月15日
    浏览(52)
  • TIA博途_通过EXCEL快速给PLC程序段添加注释信息的方法示例

    如下图所示,以OB1为例,正常情况下,我们可以在博途中直接输入各个程序段的注释信息, 但是如果程序段较多的话,逐个输入的话效率不高,此时可以参考下面这种通过EXCEL进行快速添加的方法。 如下图所示,选中某个OB或FC、FB块(这里以OB1为例进行说明),右击选择“属

    2024年02月12日
    浏览(35)
  • 【Java】源码文件开头添加注释

    应公司质量部要求,需要对代码做静态检查。质量部要求,源码文件必须在起始行起设置一些注释,然而项目已经开发了一年之久,且没有维护这个注释。 此时,面对好几千个源码文件,我们如何快速添加相应的注释呢? 对,自己写一个程序来实现。 假设注释模板为 只要获

    2024年01月17日
    浏览(41)

觉得文章有用就打赏一下文章作者

支付宝扫一扫打赏

博客赞助

微信扫一扫打赏

请作者喝杯咖啡吧~博客赞助

支付宝扫一扫领取红包,优惠每天领

二维码1

领取红包

二维码2

领红包