vscode配置代码注释插件和代码格式化插件

1. 打开vscode配置的方法

在vscode界面按F1键打开命令面板,输入settings,选择Open Settings(JSON)(这个是全局生效的配置,如果选择Open Workspace Settings(JSON)则只对当前工作空间生效,建议选择全局配置)

2. 代码注释插件配置

1. 打开Extensions侧边栏，搜索koroFileHeader插件并安装
2. 打开vscode配置,在配置文件中添加以下内容,字段可根据自己的需要增加删除;如果出错，请删除注释:

    "fileheader.cursorMode": {
        "brief": "",        // 说明
        "param[in]": "",    // 入参
        "param[out]": "",   // 出参
        "return": "",       // 返回值
        "note": ""          // 注意事项
    },
    "fileheader.customMade": {
        "FilePath": "Do not edit",  // 文件相对路径,不要修改该配置，会自动生成
        "Brief": "",                // 文件说明
        "Version": "1.0",           // 版本
        "Date": "Do not edit",      // 文件创建时间,不要修改该配置，会自动生成
        "Author": "your name",         // 文件作者
        "Copyright": "your copyright description", // 版权说明
        "LastEditors": "your name",    // 最后编辑者
        "LastEditTime": "Do not edit" // 最后编辑时间,不要修改该配置，会自动生成
    },
    "fileheader.configObj": {}

3. 插件有两种注释模式:
   1. 文件头注释：快捷键:ctrl+alt+i;对应的配置是fileheader.customMade字段,部分字段需要修改为自己的值
   2. 光标处注释:快捷键:ctrl+alt+t;对应的配置是fileheader.cursorMode字段

3. 代码格式化插件配置

1. 安装Atyle:Astyle官网,下载后解压到一个固定目录
2. 打开Extensions侧边栏，搜索Astyle插件并安装
3. 打开vscode配置,在配置文件中添加以下内容,如果出错，请删除注释:

    "[cpp]": {
        "editor.defaultFormatter": "chiehyu.vscode-astyle"  //设置astyle为默认格式化插件
    },
    "editor.formatOnSave": true,    // 保存时执行格式化
    "editor.insertSpaces": true,
    "editor.tabSize": 4,
    "astyle.additional_languages": [
        "c",
        "cpp",
    ],
    "astyle.cmd_options": [
        "--style=java", //大括号风格和缩进
        "--indent=spaces=4", //缩进使用4个空格
        "--convert-tabs", //将已有的tab转换为空格
        "--align-pointer=type", //指针跟随类型
        "--align-reference=type", //引用跟随类型
        "--attach-namespaces", //大括号与命名空间名在一行
        "--attach-classes", //大括号与类名在一行
        "--attach-closing-while", //do-while代码块中将while子句和尾大括号放在一行
        "--indent-switches", //缩进switch代码块中的内容
        "--indent-preproc-block", //缩进预处理语句
        "--indent-col1-comments", //缩进注释，与下一行代码对齐
        "--pad-oper", //操作符两边添加空格
        "--pad-comma", //逗号后添加空格
        "--pad-header", //if, for, while后添加空格
        "--break-one-line-headers", //如果if,while,else语句在一行中，则分成多行
        // "--add-braces", //给没有用大括号括起来的if,for,while,else语句添加大括号; 使用中发现某些情况下会打乱代码,故屏蔽之
        "--max-code-length=120", //单行最大字符数
        "--break-after-logical" //单行字符数超过限制时,从逻辑运算符处断开
    ],
    "astyle.executable": "D:/Program Files/AStyle/bin/Astyle"  //安装的Astyle路径

4. 上面的astyle.cmd_options字段的内容控制astyle的格式化方法，具体说明在:Astyle文档,如果需要修改请参考该文档
5. Astyle会在保存代码时自动进行格式化,也可以使用快捷键shift+alt+f手动格式化