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自动添加头注释和函数注释

下载koroFileHeader插件

然后点它的wiki文档

?会跳到它的github

配置字段 · OBKoro1/koro1FileHeader Wiki · GitHub

先找到vscdoe的setting文件,两种方法:

1,

?

然后点这里:

?或者去搜索框搜索:FileHeader

出现如下:

?然后,这三个,随便点一个:在settings.json中编辑

一般是在settings.json文件配置如下几个字段,主要参考上面的github:

"fileheader.configObj": { //快速添加文件头部注释和函数注释
        "createFileTime": true, // 设置为true则为文件新建时候作为date,否则注释生成时间为date
        "autoAdd": true, // 自动生成注释
        "language": {

            "py": {
                "head": "'''",
                "middle": "@",
                "end": "'''"
              },

            "h/hpp/cpp": {
                "head": "/*** ", // 统一增加几个*号
                "middle": " * @",
                "end": " */"
              }

        },
        "annotationStr": {
            "head": "/*",
            "middle": " * @",
            "end": " */",
            "use": true // 设置自定义注释可用
        },
    },
    "fileheader.cursorMode": { // 快速注释函数 ctrl+alt+t
        "description": "", // 函数描述
        "Author": "wujiacheng", // 作者
        "Date": "Do not edit", // 创建时间
        "param ": "", // 函数参数
        "return": "", // 函数输出

        // "LastEditTime": "Do not edit", // 最后一次修改的时间
        // "LastEditors": "wujiacheng" // 修改人员
    },
    "fileheader.customMade": { // 快速注释文件头部 ctrl+alt+i
        "Description": "", // 文件描述
        "Author": "wujiacheng", // 作者
        "Date": "Do not edit", // 创建时间
        "LastEditTime": "Do not edit", // 最后一次修改的时间
        "LastEditors": "wujiacheng" // 修改人员
    }

其中fileheader.cursorMode 是函数注释: 快捷键是 ctrl+win+t, 需要在函数的上面一行,按快捷键

fileheader.customMade是文件头部注释: 快捷键是 ctrl+win+i

fileheader.configObj 是额外的配置, 比如让头文件头部注释,增加一些符号,例如py文件的:
?

            "py": {
                "head": "'''",
                "middle": "@",
                "end": "'''"
              },

表示文件头部注释在第一行头部head增加'''

在尾部end增加'''

在中间增加@

最后效果如下:

'''
@Description: 
@Author: wujiacheng
@Date: 2022-12-23 19:14:24
@LastEditTime: 2022-12-23 19:41:33
@LastEditors: wujiacheng
'''

函数注释效果如下:

'''
@description: 
@return {*}
@Author: wujiacheng
@Date: 2022-12-24 01:25:30
@param {*} self
@param {List} nums
'''    
def maxSubArray2(self, nums: List[int]) -> int:
    n = len(nums)
    
    if n == 0:
        return 0
    if n == 1:
        return nums[0]

  开发工具 最新文章
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-12-25 11:29:10  更:2022-12-25 11:29:54 
 
开发: 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年12日历 -2024/12/26 20:56:20-

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