Visual Studio Code 设置 doxygen 格式注释

插件下载

Visual Studio Code 上快捷生成 doxygen 格式注释需要使用插件，推荐插件：cschlosser.doxdocgen，插件名全称 ：Doxygen Document Generator，如下图

插件下载地址： https://marketplace.visualstudio.com/items?itemName=cschlosser.doxdocgen

安装配置

下载完成后，打开 Visual Studio Code，点击界面左侧的扩展，接着扩展栏右上角的 ... 按钮，在下拉菜单中选择菜单底部的 " 从 VSIX 安装... (Install from VSIX...) "，找到下载好的文件进行安装。

安装完成后，进入插件的扩展设置 (扩展页插件右下角的齿轮) → " 扩展设置 (Extension Settings) "。

如需要生成注释格式为

/// @brief
/// @param [入参]
/// @return

则应如下操作

• Doxdocgen > C: Comment Prefix 设置为 ///，三斜杠后留一个空格。
  此设置项为每行注释的起始字符，若另一种类型注释则可保持默认的 *
• Doxdocgen > C: First Line 与 C: Last Line 清空
• Doxdocgen > C: Trigger Sequence
  此项为触发生成的按键，可以保持默认
• Doxdocgen > Generic: Order 此项为生成顺序，进入 Edit in settings.json 设置为如下内容

    "doxdocgen.generic.order":[
         "brief",
         "param",
         "return"
    ]

• Doxdocgen > Generic : Param Template 设置为 @param [入参] {param}

此扩展完整的 settings.json 配置为：

{
   
    "doxdocgen.generic.paramTemplate": "@param [入参] {param} ",
    "doxdocgen.c.commentPrefix": "/// ",
    "doxdocgen.c.firstLine": "",
    "doxdocgen.c.lastLine": "",
    "doxdocgen.generic.order":[
         "brief",
         "param",
         "return"
    ]
}

设置颜色

Visual Studio Code 中一般注释与 doxygen 注释的设置不同，要修改 doxygen 注释颜色，此处需要打开 vscode 的 settings.json 文件，需要进入 " 命令面板 (Command Palette...) "，vscode 左下角的设置按钮，菜单第一个选项，或者直接使用快捷键 Ctrl + Shift + P 。

打开面板后，输入 Settings, 查找并点击 " Preferences: Open User Settings "

将如下内容粘贴到 settings.json 文件中，并保存

{
   
    "editor.tokenColorCustomizations": {
   
        "textMateRules": [
            {
   
                "scope" : [
                    "comment.block.documentation.cpp",
                    "comment.line.double-slash.documentation.cpp",
                    "storage.type.class.doxygen"
                ],
                "settings": {
   
                    "foreground": "#504fa2",
                    "fontStyle": "bold"
                }
            }
        ]
    }
}

前两项的 scope 内容为 doxygen 注释
后一项的 scope 内容为 doxygen 标签 如 param ,brief 等。也可以设置为不同的颜色。

关于 doxygen 注释设置的完整 settings.json 文件，如下

{
   
    "editor.tokenColorCustomizations": {
   
        "textMateRules": [
            {
   
                "scope" : [
                    "comment.block.documentation.cpp",
                    "comment.line.double-slash.documentation.cpp",
                    "storage.type.class.doxygen"
                ],
                "settings": {
   
                    "foreground": "#504fa2",
                    "fontStyle": "bold"
                }
            }
        ]
    },
    "doxdocgen.generic.paramTemplate": "@param [入参] {param} ",
    "doxdocgen.c.commentPrefix": " /// ",
    "doxdocgen.c.firstLine": "",
    "doxdocgen.c.lastLine": "",
    "doxdocgen.generic.order":[
        "brief",
        "param",
        "return"
    ]
}

此时，在代码中输入触发 /** 后回车即可看到自动生成的 doxygen 格式的注释如下，且与常规的注释颜色有区分

查看范围

关于 settings.json 中的 scope 如何查看，一样 Ctrl + Shift + P 打开 " 命令面板 (Command Palette) "，查找并选择 " Developer: Inspect Editor Tokens and Scopes "，鼠标放在想知悉的元素上，即可知如下图查看其 scope。

参考链接：https://stackoverflow.com/questions/45195023/how-do-i-change-color-of-comments-in-visual-studio-code

其他链接：

Visual Studio Code 官网插件下载地址: https://marketplace.visualstudio.com/vscode