「VSCode」磨刀不误砍柴工

2025-06-25 约 1808 字预计阅读 4 分钟

记录 Visual Studio Code 配置及使用技巧.

配置

用户级配置
用户级热键

故障

禁用 `Git Helper`

问题起因是我在一次重启后突然发现执行 Git 远程命令（如 git push）时，终端会打印如下错误：

error: waitpid for echo failed: No child processes
error: there was a problem with the editor 'echo'

经过一番删除容器配置卷、扩展卷、重装 VS Code 的操作，均未解决。后来发现挂载到容器 /root/.gitconfig 文件中的 credential 字段在启动 VS Code 并连接到该容器后会被篡改。经检索后发现这是 VS Code 自作聪明的配置自动注入。

后来发现，大佬在帖子中指出，可以通过配置关闭该功能，具体步骤如下：

Ctrl + Shift + P
搜索 Preferences: Open Settings (JSON)
在匹配出的设置中选择合适的作用域文件（如 User 域）
在配置文件中添加如下配置

{
    "remote.containers.copyGitConfig": false,
    "remote.containers.gitCredentialHelperConfigLocation": "none",
}

最后不要忘了还原被篡改的配置文件，如 /root/.gitconfig

美化

代码编辑界面显示字符垂直标尺

通过 Json 配置修改
1. Ctrl + Shift + P
2. 搜索 Preferences: Open Settings (JSON)
3. 在匹配出的设置中选择合适的作用域文件（如 User 域）
4. 在配置文件中添加如下配置
```
"editor.rulers": [
    {"column": 80, "color": "#636267"},
    {"column": 120, "color": "#aaaaaa"}
],
```
通过 UI 修改
1. Ctrl + ,
2. 搜索 editor.rulers，并选择合适的作用域选项卡（如 User 域）
3. 在匹配出的 Editor: Rulers 设置中单击 Edit in settings.json
4. 在跳转出的配置文件中仿照前一方法进行设置

插件

koraFileHeader

koraFileHeader v4.9.3 PASSED!

    "fileheader.customMade": {  // 头部注释
        "custom_string_obkoro1_copyright": "Copyright (C) ${now_year} YIRAMI.",
        "custom_string_obkoro1": "All rights reserved.",
        "custom_string_obkoro2": "",
        // "FilePath": "Do not edit", // 文件在项目中的相对路径 自动更新
        "file": "",
        "Description": "", // 介绍文件的作用、文件的入参、出参。
        "Author": "git config user.name && git config user.email",
        "Date": "Do not edit", // 文件创建时间(不变)
        "LastEditors": "git config user.name && git config user.email",
        "LastEditTime": "Do not edit", // 文件最后编辑时间
        "version": ""
    },
    "fileheader.cursorMode": {  // 函数注释
        "description": "", // 函数注释生成之后，光标移动到这里
        "param": "", // param 开启函数参数自动提取 需要将光标放在函数行或者函数上方的空白行
        "return": "",
    },
    "fileheader.configObj": {  // 插件配置项
        "autoAdd": true, // 检测文件没有头部注释，自动添加文件头部注释
        "autoAddLine": 10, // 文件超过多少行数 不再自动添加头部注释
        "autoAlready": true, // 只添加插件支持的语言以及用户通过`language`选项自定义的注释
        "supportAutoLanguage": [], // 设置之后，在数组内的文件才支持自动添加
        // 自动添加头部注释黑名单
        "prohibitAutoAdd": [
            "json"
        ],
        "prohibitItemAutoAdd": [
            "项目的全称禁止项目自动添加头部注释, 使用快捷键自行添加"
        ],
        "folderBlacklist": [
            "node_modules"
        ], // 文件夹或文件名禁止自动添加头部注释
        "wideSame": false, // 头部注释等宽设置
        "wideNum": 13, // 头部注释字段长度 默认为13
        "functionWideNum": 0, // 函数注释等宽设置 设为0 即为关闭
        // 头部注释第几行插入
        "headInsertLine": {
            "php": 2 // php文件 插入到第二行
        },
        "beforeAnnotation": {}, // 头部注释之前插入内容
        "afterAnnotation": {}, // 头部注释之后插入内容
        "specialOptions": {
            "FilePath": "file",
            "Description": "brief",
            "Author": "author",
            "Date": "createtime",
            "LastEditors": "editor",
            "LastEditTime": "edittime",
            "description": "brief"
        }, // 特殊字段自定义 比如: Author、LastEditTime、LastEditors、FilePath、Description、Date等
        "switch": {
            "newlineAddAnnotation": true // 默认遇到换行符(\r\n \n \r)添加注释符号
        },
        "moveCursor": true, // 自动移动光标到Description所在行
        "dateFormat": "YYYY-MM-DD HH:mm:ss",
        "atSymbol": [
            "@",
            "@"
        ], // 更改所有文件的自定义注释中的@符号
        "atSymbolObj": {}, //  更改单独语言/文件的@
        "colon": [
            ": ",
            ": "
        ], // 更改所有文件的注释冒号
        "colonObj": {}, //  更改单独语言/文件的冒号
        "filePathColon": "路径分隔符替换", // 默认值： mac: / window是: \
        "showErrorMessage": false, // 是否显示插件错误通知 用于debugger
        "writeLog": false, // 错误日志生成
        "CheckFileChange": false, // 单个文件保存时进行diff检查
        "createHeader": true, // 新建文件自动添加头部注释
        "useWorker": false, // 是否使用工作区设置
        "designAddHead": false, // 添加注释图案时添加头部注释
        "headDesignName": "random", // 图案注释使用哪个图案 
        "headDesign": false, // 是否使用图案注释替换头部注释
        // 自定义配置是否在函数内生成注释 不同文件类型和语言类型
        "cursorModeInternalAll": {}, // 默认为false 在函数外生成函数注释
        "openFunctionParamsCheck": true, // 开启关闭自动提取添加函数参数
        "functionParamsShape": [
            "{",
            "}"
        ], // 函数参数外形自定义 
        // "functionParamsShape": "no type" 函数参数不需要类型
        "functionBlankSpaceAll": {}, // 函数注释空格缩进 默认为空对象 默认值为0 不缩进
        "functionTypeSymbol": "*", // 参数没有类型时的默认值
        "typeParamOrder": "type param", // 参数类型 和 参数的位置自定义
        "NoMatchParams": "no show param", // 没匹配到函数参数，是否显示@param与@return这两行 默认不显示param
        "functionParamAddStr": "", // 在 type param 后面增加字符串 可能是冒号，方便输入参数描述
        // 自定义语言注释，自定义取消 head、end 部分
        // 不设置自定义配置language无效 默认都有head、end
        "customHasHeadEnd": {}, // "cancel head and function" | "cancel head" | "cancel function" 
        "throttleTime": 60000, // 对同一个文件 需要过1分钟再次修改文件并保存才会更新注释
        // 自定义语言注释符号，覆盖插件的注释格式
        "language": {
            // js后缀文件
            "js": {
                "head": "/$$",
                "middle": " $ @",
                "end": " $/",
                // 函数自定义注释符号：如果有此配置 会默认使用
                "functionSymbol": {
                    "head": "/******* ", // 统一增加几个*号
                    "middle": " * @",
                    "end": " */"
                },
                "functionParams": "typescript" // 函数注释使用ts语言的解析逻辑
            },
            // 一次匹配多种文件后缀文件 不用重复设置
            "h/hpp/cpp": {
                "head": "/**", // 统一增加几个*号
                "middle": " * @",
                "end": " */"
            },
            // 针对有特殊要求的文件如：test.blade.php
            "blade.php": {
                "head": "<!--",
                "middle": " * @",
                "end": "-->",
            }
        },
        // 默认注释  没有匹配到注释符号的时候使用。
        "annotationStr": {
            "head": "/*",
            "middle": " * @",
            "end": " */",
            "use": false
        },
    }

目录

「VSCode」磨刀不误砍柴工

配置

故障

禁用 Git Helper

美化

代码编辑界面显示字符垂直标尺

插件

koraFileHeader

禁用 `Git Helper`