VSCode -下载安装,相关插件配置

下载安装

VSCode官网:https://code.visualstudio.com
VSCode下载地址:https://code.visualstudio.com/Download

官网打开是这个样子的,两个蓝色按钮都能下载VSCode
在这里插入图片描述
下载之后正常安装即可,最后添加个桌面快捷方式
请添加图片描述

添加中文插件:chinese

启动VSCode之后,选择extensions(或者ctrl+shift+X),搜索chinese安装重启即可

在这里插入图片描述

账户同步

如果之前使用过VSCode,并且设置了账户同步,可直接登录把之前的配置全部同步过来
在这里插入图片描述在这里插入图片描述

插件

注释插件 :koroFileHeader

在vscode中用于生成文件头部注释和函数注释的插件
github地址:https://github.com/OBKoro1/koro1FileHeader
koroFileHeader 配置字段

在 Vscode 扩展商店中搜索 koroFileHeader,点击安装即可。
打开文件->首选项->设置,搜索 FileHeader 进行设置
请添加图片描述

使用:

文件头部添加注释:
快捷键:window:ctrl+alt+i,mac:ctrl+cmd+i
在光标处添加函数注释:
快捷键:window:ctrl+alt+t,mac:ctrl+cmd+t

默认效果:

/*
 * @Author: your name
 * @Date: 2021-08-07 09:38:51
 * @LastEditTime: 2021-08-08 10:45:06
 * @LastEditors: Please set LastEditors
 * @Description: In User Settings Edit
 * @FilePath: 
 */

<!--
 * @Author: your name
 * @Date: 2021-08-07 09:38:51
 * @LastEditTime: 2021-08-08 10:45:06
 * @LastEditors: Please set LastEditors
 * @Description: In User Settings Edit
 * @FilePath: 
-->

/**
* @description: 
* @param {*} param
* @return {*}
*/	

自定义配置,其它配置可参考github配置字段

  // --------------------  koro1FileHeader 配置  --------------------
  // 头部注释
  "fileheader.customMade": {
    
    
    "Author": "AuthorName",
    "Date": "Do not edit", // 文件创建时间(不变)
    "LastEditors": "AuthorName", // 文件最后编辑者
    "LastEditTime": "Do not edit", // 文件最后编辑时间
    "Description": ""
    // "FilePath": "only file name", // 只有文件名
    // "custom_string_obkoro1_copyright": "Copyright (C) ${now_year} AuthorName. All rights reserved.",
    // "custom_string_obkoro1_date": "Do not edit" // 不带Date前缀的时间
  },
  // 函数注释
  "fileheader.cursorMode": {
    
    
    "description": "",
    //"custom_string_obkoro1": "",
    "param": "params",
    "return": ""
  },
  // 插件配置项
  "fileheader.configObj": {
    
    
    "createHeader": false, // 新建文件自动添加头部注释,默认打开
    "autoAdd": false, // 保存自动添加头部注释,开启才能自动添加,默认开启
    "openFunctionParamsCheck": true, //函数注释自动提取函数的参数,默认开启
    "createFileTime": true, // 默认为此文件的创建时间,设为false更改为当前生成注释的时间
    "dateFormat": "YYYY-MM-DD HH:mm:ss", // 默认时间格式,修改影响所有时间字段
    // 自定义注释中的艾特和冒号:
    "atSymbol": ["@", "@"], // 所有文件的头部注释和函数注释的默认值 @
    "colon": [": ", ": "] // 所有文件的头部注释和函数注释的默认值 :
    // 自定义特殊字段名,Date、LastEditTime、LastEditors、Description、FilePath
    // "specialOptions": {
    
    
    //   "Date": "since",
    //   "LastEditTime": "lastTime",
    //   "LastEditors": "LastAuthor",
    //   "Description": "message",
    //   "FilePath": "文件相对于项目的路径"
    // }
    // 函数参数配置
    // "functionParamsShape": "normal", // 正常
    // "functionParamsShape": "no bracket", // 没有方括号
    // "functionParamsShape": "no type", // 没有类型
    // "functionParamsShape": [ "{", "}"], // 函数参数外形自定义,默认值 {}
    // "functionTypeSymbol": "*", // 参数没有类型时的默认值 *
    // 函数设置不添加参数和类型 {*}
    // "functionParamsShape": "no type", // 没有类型
    // "functionTypeSymbol": "" // 参数没有类型时的默认值 *
  }
  // --------------------  koro1FileHeader 配置  --------------------

自定义配置效果:

/*
 * @Author: AuthorName
 * @Date: 2021-08-08 11:32:15
 * @LastEditors: AuthorName
 * @LastEditTime: 2021-08-08 12:50:45
 * @Description: 
 */
/**
* @description: 
* @param {*} param
* @return {*}
*/	

自定义配置2

  // --------------------  koro1FileHeader 配置  --------------------
  // 头部注释
  "fileheader.customMade": {
    
    
    "FilePath": "only file name", // 只有文件名
    "custom_string_obkoro1": "",
    "Date": "Do not edit", // 文件创建时间(不变)
    "custom_string_obkoro1_copyright": " Copyright (c) ${now_year} AuthorName. All rights reserved.",
    "Description": ""
  },
  // 函数注释
  "fileheader.cursorMode": {
    
    
    // "custom_string_obkoro1": "",
    "param": "",
    "return": ""
  },
  // 插件配置项
  "fileheader.configObj": {
    
    
    "createHeader": false, // 新建文件自动添加头部注释,默认打开
    "autoAdd": false, // 保存自动添加头部注释,开启才能自动添加,默认开启
    "openFunctionParamsCheck": true, //函数注释自动提取函数的参数,默认开启
    "createFileTime": true, // 默认为此文件的创建时间,设为false更改为当前生成注释的时间
    "dateFormat": "YYYY/MM/DD", // 默认时间格式,修改影响所有时间字段
    // 自定义注释中的艾特和冒号:
    "atSymbol": ["", "@"], // 所有文件的头部注释和函数注释的默认值 @
    "colon": ["", ": "], // 所有文件的头部注释和函数注释的默认值 :
    // 自定义特殊字段名,Date、LastEditTime、LastEditors、Description、FilePath
    "specialOptions": {
    
    
      "FilePath": " ",
      "Date": " Created by AuthorName on ",
      "Description": " description:"
    },
    // 函数参数配置
    "functionParamsShape": "no type", // 没有类型
    "functionTypeSymbol": "" // 参数没有类型时的默认值 *
  }
  // --------------------  koro1FileHeader 配置  --------------------

自定义配置效果2:

<!--
 *  base-navbar.vue
 * 
 *  Created by AuthorName on 2021/08/07
 *  Copyright (c) 2021 AuthorName. All rights reserved.
 *  description:
-->

/**
 * 
 * @param s
 * @return no
 */

Guess you like

Origin blog.csdn.net/iotjin/article/details/119423845