IT数码 购物 网址 头条 软件 日历 阅读 图书馆
TxT小说阅读器
↓语音阅读,小说下载,古典文学↓
图片批量下载器
↓批量下载图片,美女图库↓
图片自动播放器
↓图片自动播放器↓
一键清除垃圾
↓轻轻一点,清除系统垃圾↓
开发: C++知识库 Java知识库 JavaScript Python PHP知识库 人工智能 区块链 大数据 移动开发 嵌入式 开发工具 数据结构与算法 开发测试 游戏开发 网络协议 系统运维
教程: HTML教程 CSS教程 JavaScript教程 Go语言教程 JQuery教程 VUE教程 VUE3教程 Bootstrap教程 SQL数据库教程 C语言教程 C++教程 Java教程 Python教程 Python3教程 C#教程
数码: 电脑 笔记本 显卡 显示器 固态硬盘 硬盘 耳机 手机 iphone vivo oppo 小米 华为 单反 装机 图拉丁
 
   -> 开发工具 -> VScode自动添加注释 -> 正文阅读

[开发工具]VScode自动添加注释

VScode头部注释与函数注释

koroFileHeader

需要先去扩展中下载koroFileHeader插件,然后设置中搜索fileheader,如下图:
在这里插入图片描述
这里面包含config Obj、Cursor Mode、Cuetom Made的配置文件,需要我们自己添加一些配置文件然后就可以实现自动注释,点击任意一个settings.json进去。

Fileheader文件配置

在fileheader文件中需要添加如下两个文件,分别是函数注释和头部注释:

"fileheader.cursorMode": {
        "description": "", // 函数注释生成之后,光标移动到这里
        "param": "", // param 开启函数参数自动提取 需要将光标放在函数行或者函数上方的空白行
        "return": "",
    },
    "fileheader.customMade": {
        "Author": "Wujiahuo", // 创建文件的作者
        "Date": "Do not edit", // 文件创建时间(不变)
        "LastEditors": "OBKoro1", // 文件最后编辑者
        // 由于编辑文件就会变更最后编辑时间,多人协作中合并的时候会导致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": "Creator", 
        //"custom_string_obkoro2": "18558895058", 
        // 版权声明 保留文件所有权利 自动替换年份

        "custom_string_obkoro1_copyright": "Copyright (c) ${now_year} by Wujiahuo/bzlrobot, All Rights Reserved. "
       
    }
}

插入图片注释则是在fileheader.Config Obj中,目前我只知道头部插入携带,单独的插入没有找到资料:

"fileheader.configObj": {
        


        "designAddHead": false, // 默认关闭, 生成的图案注释是否附带头部注释
        "headDesignName": "totemDragon", // 默认为随机图案 生成哪个注释图案
        "headDesign": false,// 默认关闭 开启后,所有生成头部注释的场景都会生成图案注释

头部注释快捷键为:
window:ctrl+win+i
mac:ctrl+cmd+i
linux: ctrl+meta+i
Ubuntu: ctrl+super+i
函数注释快捷键为:
window:ctrl+win+t
mac:ctrl+cmd+t
linux: ctrl+meta+t
Ubuntu: ctrl+super+t
函数注释光标移动到下一行,快速添加函数参数描述
window: win+y
mac: cmd+y
linux: meta+y

  开发工具 最新文章
Postman接口测试之Mock快速入门
ASCII码空格替换查表_最全ASCII码对照表0-2
如何使用 ssh 建立 socks 代理
Typora配合PicGo阿里云图床配置
SoapUI、Jmeter、Postman三种接口测试工具的
github用相对路径显示图片_GitHub 中 readm
Windows编译g2o及其g2o viewer
解决jupyter notebook无法连接/ jupyter连接
Git恢复到之前版本
VScode常用快捷键
上一篇文章      下一篇文章      查看所有文章
加:2022-07-17 16:44:21  更:2022-07-17 16:46:06 
 
开发: C++知识库 Java知识库 JavaScript Python PHP知识库 人工智能 区块链 大数据 移动开发 嵌入式 开发工具 数据结构与算法 开发测试 游戏开发 网络协议 系统运维
教程: HTML教程 CSS教程 JavaScript教程 Go语言教程 JQuery教程 VUE教程 VUE3教程 Bootstrap教程 SQL数据库教程 C语言教程 C++教程 Java教程 Python教程 Python3教程 C#教程
数码: 电脑 笔记本 显卡 显示器 固态硬盘 硬盘 耳机 手机 iphone vivo oppo 小米 华为 单反 装机 图拉丁

360图书馆 购物 三丰科技 阅读网 日历 万年历 2024年5日历 -2024/5/18 15:03:36-

图片自动播放器
↓图片自动播放器↓
TxT小说阅读器
↓语音阅读,小说下载,古典文学↓
一键清除垃圾
↓轻轻一点,清除系统垃圾↓
图片批量下载器
↓批量下载图片,美女图库↓
  网站联系: qq:121756557 email:121756557@qq.com  IT数码