Visual Studio Code 设置 doxygen 格式注释

简介: vs code 使用 cschlosser.doxdocgen 插件,设置 doxygen 注释格式

插件下载

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

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

安装配置

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

vscode_extension.png

安装完成后,进入插件的扩展设置 (扩展页插件右下角的齿轮) → " 扩展设置 (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 "
vscode_controlpalette.png

将如下内容粘贴到 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 等。也可以设置为不同的颜色。

vscode.png

关于 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 格式的注释如下,且与常规的注释颜色有区分

vscode_doxygencomment.png

查看范围

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

vscode2.png

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

其他链接

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

目录
相关文章
|
1月前
|
JavaScript 前端开发 开发者
如何在 Visual Studio Code (VSCode) 中使用 ESLint 和 Prettier 检查代码规范并自动格式化 Vue.js 代码,包括安装插件、配置 ESLint 和 Prettier 以及 VSCode 设置的具体步骤
随着前端开发技术的快速发展,代码规范和格式化工具变得尤为重要。本文介绍了如何在 Visual Studio Code (VSCode) 中使用 ESLint 和 Prettier 检查代码规范并自动格式化 Vue.js 代码,包括安装插件、配置 ESLint 和 Prettier 以及 VSCode 设置的具体步骤。通过这些工具,可以显著提升编码效率和代码质量。
361 4
|
7月前
|
前端开发 开发工具 C++
vscode ( Visual Studio Code )设置中文、字体和字号
vscode ( Visual Studio Code )设置中文、字体和字号
426 0
|
C++ 计算机视觉
解决方案-Visual Studio设置通用配置(包含路径+依赖库)
解决方案-Visual Studio设置通用配置(包含路径+依赖库)
358 0
|
C语言 C++ Python
【ROS 开发神器 Visual Studio Code 的安装和设置】
【ROS 开发神器 Visual Studio Code 的安装和设置】
985 0
【ROS 开发神器 Visual Studio Code 的安装和设置】
|
XML 数据格式 C++
Visual Studio 2019 设置 doxygen 注释颜色
VS 中如何修改 doxygen 格式注释的颜色
274 0
Visual Studio 2019 设置 doxygen 注释颜色
Visual Studio 2019 设置程序结束控制台不关闭
修改设置使控制台应用运行结束,控制台不自动退出。
503 0
Visual Studio 2019 设置程序结束控制台不关闭
|
C++
Visual Studio 2019 设置手动触发 clang-format 格式化
合作开发时,.clang-format 文件会在编写代码的过程中自动执行格式化,触发某些条件将自动格式化整个文件,有可能导致代码冲突的概率提升,也会造成编码时的不便。
872 0
Visual Studio 2019 设置手动触发 clang-format 格式化
|
C++
Visual Studio 2019 实用功能设置(背景颜色,代码字体及行号设置)
Visual Studio 2019 安装包的下载教程、安装教程 教程第一篇:Visual Studio 2019 详细安装教程(图文版) 第二篇:Visual Studio 2019 实用功能设置(背景颜色,代码颜色及行号设置) 第三篇:Visual Studio 2019 代码调试技巧 第四篇:Visual Studio 2019 解决scanf 警告问题
1124 0
|
编译器 C++
Visual Studio 2022 中如何设置背景图片,壁纸
Visual Studio 2022 中如何设置背景图片,壁纸