VS Code ---- 使用笔记

记录一些VS Code 日常使用遇到的问题

修改打开文件使用的默认编码

1. 使用 Ctrl + , 快捷键打开设置
2. 搜索框 输入 Encoding 搜索
3. 在搜索的结果中 设置想要的编码
   

VS Code 关闭 C/C++ 红色波浪线

1. Ctrl + , 呼出设置菜单
2. 搜索 squiggle
3. 将Error Squiggles 选项 修改为 Disable
   

KoroFileHeader 注释插件使用

说明

• 软件版本 : VS Code 1.66.1
• 插件版本 : KoroFileHeader v4.8.21
• 说明 :
• Github参考连接 : 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

插件使用配置

1. 进入VS Code 扩展(Ctrl + Shift + x), 找到 KoroFileHeader; 点击 设置图标 -> 点击 扩展设置;
   
2. 进入的页面 选择=> Fileheader: Config Obj => 在settings.json中编辑
   
3. 将文件内所有内容替换为如下代码(关闭了自动添加文件头部注释; 添加头部注释和函数注释, 更改了data的日期生成方式为生成注释的时间)

{
    "files.encoding": "gb2312",
    "editor.renderIndentGuides": false,
    "editor.bracketPairColorization.enabled": true,
    "workbench.editor.enablePreview": false,
    "fileheader.configObj": {
        "createFileTime": false,
        "language": {
            "languagetest": {
                "head": "/$$",
                "middle": " $ @",
                "end": " $/",
                "functionSymbol": {
                    "head": "/** ",
                    "middle": " * @",
                    "end": " */"
                },
                "functionParams": "js"
            }
        },
        "autoAdd": false,
        "autoAddLine": 100,
        "autoAlready": true,
        "annotationStr": {
            "head": "/*",
            "middle": " * @",
            "end": " */",
            "use": false
        },
        "headInsertLine": {
            "php": 2,
            "sh": 2
        },
        "beforeAnnotation": {
            "文件后缀": "该文件后缀的头部注释之前添加某些内容"
        },
        "afterAnnotation": {
            "文件后缀": "该文件后缀的头部注释之后添加某些内容"
        },
        "specialOptions": {
            "特殊字段": "自定义比如LastEditTime/LastEditors"
        },
        "switch": {
            "newlineAddAnnotation": true
        },
        "supportAutoLanguage": [],
        "prohibitAutoAdd": [
            "json"
        ],
        "folderBlacklist": [
            "node_modules",
            "文件夹禁止自动添加头部注释"
        ],
        "prohibitItemAutoAdd": [
            "项目的全称, 整个项目禁止自动添加头部注释, 可以使用快捷键添加"
        ],
        "moveCursor": true,
        "dateFormat": "YYYY-MM-DD",
        "atSymbol": [
            "@",
            "@"
        ],
        "atSymbolObj": {
            "文件后缀": [
                "头部注释@符号",
                "函数注释@符号"
            ]
        },
        "colon": [
            ": ",
            ": "
        ],
        "colonObj": {
            "文件后缀": [
                "头部注释冒号",
                "函数注释冒号"
            ]
        },
        "filePathColon": "路径分隔符替换",
        "showErrorMessage": false,
        "writeLog": false,
        "wideSame": false,
        "wideNum": 13,
        "functionWideNum": 0,
        "CheckFileChange": false,
        "createHeader": true,
        "useWorker": false,
        "designAddHead": false,
        "headDesignName": "random",
        "headDesign": false,
        "cursorModeInternalAll": {},
        "openFunctionParamsCheck": true,
        "functionParamsShape": [
            "{",
            "}"
        ],
        "functionBlankSpaceAll": {},
        "functionTypeSymbol": "*",
        "typeParamOrder": "type param",
        "customHasHeadEnd": {},
        "throttleTime": 60000
    },
    // 头部注释 Ctrl + Win + i
    "fileheader.customMade": {
        "Author": "Evans_Y", // 创建文件的作者
        "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": "",
        // 版权声明 保留文件所有权利 自动替换年份
        "custom_string_obkoro1_copyright": "Copyright (c) ${now_year} by 用户/公司名, All Rights Reserved. "
    },
    // 函数注释 Ctrl + Win + t
    "fileheader.cursorMode": {
        //"description": "", // 函数注释生成之后，光标移动到这里
        "Tip": "Evans_Y  | V 1.0.0.0",
        "Date": "Do not edit", // 注释生成时间
        "Description": "",
        "param": "", // param 开启函数参数自动提取 需要将光标放在函数行或者函数上方的空白行
        "return": "",
    }
}

5. 重新打开 VS Code
6. 效果

• 文件头注释
  

• 函数注释