VSCode插件-Doxygen Documentation Generator

ubuntu 使用doxygen生成软件文档[Vscode 配置doxygen插件方法] ubuntu下使用doxygen生成软件文档, ubuntu下使用Vscode自动生成符合doxygen语法的注释 阅读详情
AI摘要

该博客介绍了使用VSCode为程序文件和函数生成注释的方法。用户可通过修改配置文件来自定义文件注释模板,选择对当前用户所有工作区有效的JSON配置文件,粘贴相应内容。还展示了文件和函数注释的验证效果,函数注释可使用默认模板。

简介

可以为程序文件和函数生成注释

修改配置文件

默认的文件注释模板一般不符合个性化的需求,如果要自定义文件注释模板,则需要修改配置文件。
按下快捷键ctrl+shit+p,调出快速导航窗口,在编辑框中输入json,如下所示:
在这里插入图片描述

  • “Preferences:Open User Settings(JSON)”:json格式的配置文件,对当前用户的所有工作区有效
  • “Preferences:Open Workspace Settings(JSON)”:json格式的配置文件,只对当前工作区有效

我们选择 “Preferences:Open User Settings(JSON)”,单击打开JSON文件,并将如下内容粘贴到JSON文件中:

    "doxdocgen.file.fileOrder": [
        "file",
        "version",
        "date",
        "brief",
        "empty",
        "custom",
        "empty",
        "empty",
        "copyright"
      ],
      "doxdocgen.file.versionTag": "@version A001",
      "doxdocgen.file.customTag": [
        "@par 版本记录",
        "",
        "修改日期 | 版本 | 修改人 |修改内容",
        "-|-|-|-",
        "{date}|A001|xxx|初始版本"
    ],
    "doxdocgen.file.copyrightTag": [
        "@copyright 2004-{year} (C) Copyright xxx Technology Inc."
    ],

JSON内容如下:
在这里插入图片描述

验证效果

文件注释

在文件的第一行输入/**然后点击enter键,生成的文件注释如下:
在这里插入图片描述
注释的每一行和配置文件中"doxdocgen.file.fileOrder"是一 一对应的
在这里插入图片描述

函数注释

函数注释模板不需要修改,直接用默认的即可。
在需要添加注释的函数上一行输入/**然后按enter键即可为函数添加注释,效果如下所示:
在这里插入图片描述

配置选项

{
    // 用于每行注释(首行和尾行除外)的前缀。
    "doxdocgen.c.commentPrefix": " * ",
    // 工厂方法/函数的智能文本片段。
    "doxdocgen.c.factoryMethodText": "Create a {name} object",
    // 生成注释的第一行。如果为空,则不会生成。
    "doxdocgen.c.firstLine": "/**",
    // 获取器的智能文本片段。
    "doxdocgen.c.getterText": "Get the {name} object",
    // 生成注释的最后一行。如果为空,则不会生成。
    "doxdocgen.c.lastLine": " */",
    // 设置器的智能文本片段。
    "doxdocgen.c.setterText": "Set the {name} object",
    // 触发 Doxygen 注释生成的字符序列。
    "doxdocgen.c.triggerSequence": "/**",
    // 构造函数的智能文本片段。
    "doxdocgen.cpp.ctorText": "Construct a new {name} object",
    // 析构函数的智能文本片段。
    "doxdocgen.cpp.dtorText": "Destroy the {name} object",
    // 生成的模板参数 Doxygen 行的模板。如果为空,则不会生成。
    "doxdocgen.cpp.tparamTemplate": "@tparam {param} ",
    // 文件版权文档标签。字符串数组将被转换为每个元素一行。可以使用 {year} 模板。
    "doxdocgen.file.copyrightTag": [
    "@copyright Copyright (c) {year}"
    ],
    // 额外的文件文档。每个标签占一行,将被添加。可以使用 {year}、{date}、{author}、{email} 和 {file} 模板。需要指定前缀。
    "doxdocgen.file.customTag": [],
    // 文件注释的顺序。值可以多次使用。有效值如默认设置所示。
    "doxdocgen.file.fileOrder": [
        "file",
        "author",
        "brief",
        "version",
        "date",
        "empty",
        "copyright",
        "empty",
        "custom"
    ],
    // Doxygen 文件参数的模板。
    "doxdocgen.file.fileTemplate": "@file {name}",
    // 文件的版本号。
    "doxdocgen.file.versionTag": "@version 0.1",
    // 设置作者的电子邮件地址。替换 {email}。
    "doxdocgen.generic.authorEmail": "you@domain.com",
    // 设置作者的名称。替换 {author}。
    "doxdocgen.generic.authorName": "your name",
    // 设置作者标签的样式和你的名字。可以使用 {author} 和 {email} 模板。
    "doxdocgen.generic.authorTag": "@author {author} ({email})",
    // 如果启用,布尔返回值将被拆分为 true 和 false 返回参数。
    "doxdocgen.generic.boolReturnsTrueFalse": true,
    // 生成的简要 Doxygen 行的模板。如果为空,则不会生成。
    "doxdocgen.generic.briefTemplate": "@brief {text}",
    // 日期的格式。
    "doxdocgen.generic.dateFormat": "YYYY-MM-DD",
    // Doxygen 日期参数的模板。
    "doxdocgen.generic.dateTemplate": "@date {date}",
    // 决定是否为某些命令生成智能文本。
    "doxdocgen.generic.generateSmartText": true,
    // 是否在返回值中包含类型信息。
    "doxdocgen.generic.includeTypeAtReturn": true,
    // 插件应查找多少行以确定声明的结束。请注意,将此值设置得过低可能会略微提高注释生成的速度,但插件可能无法正确检测所有声明或定义。
    "doxdocgen.generic.linesToGet": 20,
    // 注释生成的顺序。值可以多次使用。有效值如默认设置所示。
    "doxdocgen.generic.order": [
        "brief",
        "empty",
        "tparam",
        "param",
        "return",
        "custom",
        "version",
        "author",
        "date",
        "copyright"
    ],
    // 添加到通用顺序的自定义标签。每个标签占一行,将被添加。可以使用 {year}、{date}、{author}、{email} 和 {file} 模板。需要指定前缀。
    "doxdocgen.generic.customTags": [],
    // 生成的参数 Doxygen 行的模板。如果为空,则不会生成。
    "doxdocgen.generic.paramTemplate": "@param {param} ",
    // 生成的返回 Doxygen 行的模板。如果为空,则不会生成。
    "doxdocgen.generic.returnTemplate": "@return {type} ",
    // 决定是否根据大小写拆分 {name} 中的值。
    "doxdocgen.generic.splitCasingSmartText": true,
    // 在解析之前应从输入中移除的关键字数组。
    "doxdocgen.generic.filteredKeywords": [],
    // 使用 git config --get user.name 替换 {author}。
    "doxdocgen.generic.useGitUserName": false,
    // 使用 git config --get user.email 替换 {email}。
    "doxdocgen.generic.useGitUserEmail": false,
    // 提供 Doxygen 命令的智能感知和代码片段。
    "doxdocgen.generic.commandSuggestion": true,
    // 在 Doxygen 命令建议中添加 \\ 以提高可读性(需要启用 commandSuggestion)。
    "doxdocgen.generic.commandSuggestionAddPrefix": false,
}
vscode 配置doxygen注释和snippet 本文介绍了如何在VSCode中配置Doxygen注释和代码片段,以提升C/C++代码的文档化效率。Doxygen注释原则涵盖了文件头、命名空间、类、结构、枚举、函数、变量、模块和分组的标注。文章还提供了常用的Doxygen指令表格,如@file、@brief、@author等,并展示了文件注释的示例代码。通过这些配置,开发者可以快速生成规范的代码注释,提升代码的可读性和维护性。 阅读详情

相关推荐

VSCode C/C++ 开发环境:5个必备插件与头文件保护宏自动生成

本文详细介绍了如何在Visual Studio Code(VSCode)中配置高效的C/C++开发环境,包括5个必备插件和头文件保护宏自动生成技巧。通过C/C++ IntelliSense、CMake Tools等核心插件,开发者可以提升代码编写效率,同时利用代码片段功能实现#ifndef、#define等头文件保护宏的自动生成,优化开发工作流。

weixin_31321361的博客 337

VSCode 自动生成 Doxygen 格式注释

本文介绍了在VS Code中使用Doxygen注释生成插件的方法。推荐安装cschlosser.doxdocgen插件,详细说明了安装步骤和配置过程。通过JSON配置示例展示了如何设置文件注释模板(包含版权信息、修改日志等)和函数注释模板(含参数说明、返回值等)。配置后只需输入"/**"回车即可自动生成规范的Doxygen注释,包括文件头信息(作者、版本、日期)和函数说明(参数、返回值)。该工具能有效提高代码注释效率,适合团队协作开发。

人无远虑,必有近忧 7988

VSCode结合Doxygen实现高效代码文档自动化

本文详细介绍了如何在VSCode中集成Doxygen,搭建高效的代码文档自动化工作流。通过安装核心插件、编写符合规范的注释,并配置Doxyfile,开发者可以一键生成结构清晰、包含图表和交叉引用的专业文档。该方法能显著提升团队协作效率和代码可维护性,实现文档与代码的同步更新。

weixin_28837817的博客 230

VSCODE 使用插件 Doxygen Documentation Generator

VSCODE 使用插件 Doxygen Documentation Generator 文章目录VSCODE 使用插件 Doxygen Documentation Generator1.安装插件`Doxygen Documentation Generator`2.修改相关代码(不改也可以,可跳过)方法1,打开设置,从插件处更改方法2,修改setting.json3.使用4.额外补充(可不看) 1.安装插件Doxygen Documentation Generator 2.修改相关代码(不改也可以,可跳过)

gxt_kt的博客 2万+

doxygen代码文档生成工具

可以按照doxygen规定的格式编写代码注释,然后利用doxygen工具直接生成参考文档

Redis【实战篇】---- 分布式锁-redission

重入问题:重入问题是指 获得锁的线程可以再次进入到相同的锁的代码块中,可重入锁的意义在于防止死锁,比如HashTable这样的代码中,他的方法都是使用synchronized修饰的,假如他在一个方法内,调用另一个方法,那么此时如果是不可重入的,不就死锁了吗?所以可重入锁他的主要意义是防止死锁,我们的synchronized和Lock锁都是可重入的。不可重试:是指目前的分布式只能尝试一次,我们认为合理的情况是:当线程在获得锁失败后,他应该能再次尝试获得锁。

是微风,是晚霞,是无可替代 1万+

VSCODE 使用插件 Doxygen Documentation Generator 配置 TaoToken 的完整指南

在 VSCODE 中用 Doxygen Documentation Generator 插件配置 TaoToken,只需在 setting.json 填入 Base URL、API Key 与 Model ID 三件套,即可统一模型调用通道。本文提供可复制配置片段、/** 自动生成注释验证步骤,以及 401、choices 报错排查方法。官网:https://taotoken.net/?utm_source=taotoken_aicg_blog_end

weixin_35756373的博客 9

Unity适配Nintendo Switch平台开发

查看文档、下载SDK,都需要账号登录。

凝遥的笔记本 2107

[转] VSCODE 使用插件 Doxygen Documentation Generator

https://blog.csdn.net/my_id_kt/article/details/122852676

sroman的博客 1613

死磕GMSSL通信-java/Netty系列(二)

Netty-tcnative再linux编译比较好编译,但是再window编译,我尝试了各种办法,总是编译失败,所以我采用半自动的方式进行编译,Netty-tcnative会生成临时文件,直接用vs打开,设置openssl的头文件和静态库路径,然后生成静态库,静态库改个名字放到jar包里边,其实自动编译也是这个原理哈哈O(∩_∩)O。直接传输五个证书的路径吗,之前有的是说要转成x509之类的,转来转去的有点麻烦,这个是直接传输证书路径,由底层gmssl去解析,格式必须是pem格式。然而,若项目已依赖于。

qq_36577699的博客 3028

微信小程序转化数据API自归因实战:PHP实现与2025升级要点解析

本文详细解析了2025年微信小程序转化数据API自归因的升级要点与PHP实战实现。核心变化包括接口地址更新、固定access_token的获取方式,以及新增timestamp与nonce等安全参数。文章提供了完整的PHP代码示例,帮助开发者高效完成数据上报,优化腾讯广告投放效果。

git9versioner的博客 989

【Doxygen】Vscode 插件 DoxyGen Documentation Generator C语言详细设置

Doxygen Documentation Generator C语言详细设置

qq_39030013的博客 4505

Kolla 容器化 高可用OpenStack 部署与 Ceph 集群集成

本文介绍了 Kolla 项目在容器化 OpenStack 部署和管理方面的应用,以及与 Ceph 集群的集成。Kolla 项目通过容器技术提供了一种简化和自动化的 OpenStack 部署方法,同时实现了易于升级和回滚的特点。本文还探讨了 Kolla 在实现零宕机升级方面的进展,并分析了其对 OpenStack 用户和社区的重要意义。

we22635的博客 2704

VSCode插件Doxygen Documentation Generator:用TaoToken统一Key生成注释模板的配置与验证

在 VSCode 中配置 Doxygen Documentation Generator 插件,用 settings.json 片段统一注释模板,再通过 TaoToken 官网 https://taotoken.net/?utm_source=taotoken_aicg_blog_end 获取统一 Key 与 API 地址,让脚本为函数签名生成注释草稿,并附 401、choices 报错排查与验证步骤。

weixin_42576410的博客 7

OpenRubrics:自动化评估工具优化LLM对齐效果

在大型语言模型(LLM)应用中,模型输出与人类价值观的对齐是关键挑战。传统人工反馈强化学习(RLHF)依赖大量标注,成本高且一致性差。OpenRubrics作为开源工具,通过结构化准则实现自动化评估,显著提升效率。其核心原理是将主观评价转化为可量化的多维指标,支持动态权重调整,并兼容主流RLHF框架。该工具在降低标注成本的同时,通过Fleiss' Kappa系数等指标保证评估一致性,适用于多语言和医疗等专业领域,为LLM对齐提供了工程化解决方案。

weixin_28730037的博客 361

【Unity 实用工具篇】 | Unity网格破碎插件 unity-fracture

前面写过一篇Unity中物体破碎效果的插件:【Unity 实用工具篇】 | Unity物体破碎效果 OpenFracture 本文介绍一个另外的工具unity-fracture,也可以实现网格破碎效果,且功能与OpenFracture略有差异。

努力前行,总会成为自己心中的那道光 1万+

VSCode 自动添加函数注释头插件怎么配?Doxygen Documentation Generator 与 TaoToken 的协作实践

VSCode 函数注释头配置实战:用 Doxygen Documentation Generator 插件配合 settings.json 一键生成 @param、@return 模板,再通过 TaoToken 统一 API 通道接入 AI 补全描述,附 401 与 local proxy failed 排查路径。官网 https://taotoken.net/?utm_source=taotoken_aicg_blog_end

weixin_42579969的博客 8

ICC2:mem出pin的Off Grid问题

这个命令本意是解决跨制成调用IP时在IP出pin位置加一定的routing blockage,限制绕线在一定范围内只能走直线出pin,用来解决off-grid问题也有很好的效果。在ICC2做先进工艺时会有off-grid的问题,off-grid可以理解为绕线没有在preferred方向track上。测试发现,2022版本以前的ICC2绕线容易有off-grid问题。主要在mem出pin的M2/M3层次上,切换版本绕线能很大程度上解决这个问题。我正在「拾陆楼」和朋友们讨论有趣的话题,你⼀起来吧?

m0_61544122的博客 1631

VSCode 插件 Doxygen Documentation Generator 配 TaoToken:settings.json 骨架与注释生成验证

在 VSCode 中为 C/C++ 项目配置 Doxygen Documentation Generator 插件,复制 settings.json 骨架即可让 /** 触发规范注释。本文提供完整配置与验证步骤,并说明如何通过 TaoToken 官网 https://taotoken.net/?utm_source=taotoken_aicg_blog_end 接入模型补全 @brief 语义描述,统一注释通道。

weixin_42609225的博客 12

怀旧版电脑GBC模拟器

再现原版GBC掌机的界面,电脑运行连游戏界面都一样大小,很怀旧,很真实,(英文版)强烈推荐,很小的文件,很难才找到的。

IEM模型,地表粗糙度模拟

利用微波反演土壤水分时候,利用IEM模型可以实现对随机地表的模拟

【VScode实用生产力插件】

Vcode 配置成生产力 1. Plantuml插件 [插件名:Plantuml] 简介:PlantUML是一个可以快速编写UML图的组件。支持【顺序图,用例图,类图,对象图,活动图(旧语法),组件图,部署图,状态图,时序图】【JSON数据,YAML数据,网络图(nwdiag),线框图形界面或UI模拟(盐),架构图,规范和描述语言(SDL),Ditaa图,甘特图,思维导图,图示工作分解结构图(WBS),用AsciiMath或JLaTeXMath符号进行数学计算,实体关系图(IE/ER)】 官网 http

weixin_43966547的博客 2416

ET2012新版免狗免安装绿色软件

ET2012新版免狗免安祖昂绿色软件。,新界面,新视觉,

注释插件使用 Doxygen Documentation Generator

在setting中添加内容。

Car12 588

WINCC7.3破解文件

WINCC7.3硬件够破解文件,有需要的下载!WINCC7.3硬件够破解文件,有需要的下载!

【Doxygen】Vscode 插件 DoxyGen Documentation Generator C语言详细设置:从零生成可维护的注释文档

用 VSCode 的 DoxyGen Documentation Generator 插件为 C 语言项目自动生成 Doxygen 注释模板,输入 /** 回车即可填充参数与返回值。本文给出可复制的 settings.json 与 Doxyfile 配置,串起注释规范、HTML 文档生成与常见报错排查,并说明如何通过 TaoToken 官网 https://taotoken.net/?utm_source=taotoken_aicg_blog_end 调用模型辅助排查配置。

weixin_42376614的博客 9

【Doxygen】Vscode 插件 DoxyGen Documentation Generator C语言详细设置:从 config.toml 骨架到注释生成验证

用 Vscode 的 DoxyGen Documentation Generator 插件为 C 语言项目自动生成 Doxygen 注释骨架,从 settings.json 模板到 Doxyfile 关键项一次配齐。文中给出可复制的 config 骨架与验证步骤,并说明如何通过 TaoToken 官网 https://taotoken.net/?utm_source=taotoken_aicg_blog_end 接入 API 辅助补全注释文本。

weixin_42591908的博客 8

vscode 自动生成Doxygen格式注释

前言 ​ 程序中注释的规范和统一性的重要性不言而喻,本文就推荐一种在用vscode编写代码时自动化生成标准化注释格式的方法,关于Doxygen规范及其使用可查看博文 代码注释规范之Doxygen。 ​ 本方法仅作为Doxygen注释的辅助作用。 Vs code自动生成Doxygen格式注释 环境 Vs code Doxygen Documentation Generator 插件 Doxygen Documentation Generator插件使用及配置 安装插件后,File–Prefer

ABC_ORANGE的博客 5114

vscode 插件

office viewer

u010669626的博客 339

【面向小白】vscode最佳实践(4)—— 搭建c/c++环境2(插件安装,vscode基础操作讲解)

本文讲解了vscode开发c/c++的必装插件和设置。

weixin_41096870的博客 1184
上一篇: Xilinx SDK 2018在现有工程上添加fatfs模块后编译时报错undefined reference to f_mount
he3kys
博客等级 码龄11年 12粉丝 6原创
评论
成就一亿技术人!
拼手气红包6.0元
还能输入1000个字符
 
 条评论被折叠 查看
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付:10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值