【小工具】-Doxygen01-优快云博客

0、前言

参考帖子。
使用Doxygen Documentation Generator自动添加注释
 Doxygen使用教程
 代码注释规范之Doxygen

1、Doxygen介绍

Doxygen 是一个功能强大的开源文档生成工具，主要用于从源代码中自动提取注释并生成专业的 API 文档。它支持多种编程语言（C、C++、Java、Python、Objective-C 等），广泛应用于软件开发、库开发和技术文档编写。

自动提取代码注释
生成多种格式的文档
生成类图和依赖关系
自动生成文档结构组织
条件编译文档（通过 \if、\else、\endif 为不同平台或配置生成不同文档）

2、Doxygen常用注释命令

@project与\project等效，其它注释命令也是一样的道理。

注释命令	含义
@project	描述项目
@file	描述文件
@author	作者信息
@version	描述版本
@date	描述时间
@copyright	描述权限
@attention	注意事项
@brief	概要信息
@example	使用示例
@ wanrning{warning message}	一些需要注意的事情
@ todo{things to be done}	即将要做的事情，会链接到todo列表
@ bug	有缺陷的地方，会链接到bug列表
@see	引用其它文档或项目
@code···@endcode	注释中说明某一代码段
@deprecated	废弃的函数
@note	开始一个段落，用来描述一些注意事项
@param	标注一个参数的意义
@return	描述一个返回的意义
@include	标注包含文件
@var	描述变量
@enum	描述枚举
@struct	描述结构体
@clas	描述类

3、如何在VSCode中使用Doxygen

Doxygen有专门的工具，不过我目前是在vscode中安装Doxygen Documentation Generator，暂时只需要快速生成规范性注释。若需要生成文档或图表，就需要使用Doxygen工具了。
在这里插入图片描述

4、如何进行自定义规范

可以在setting.json文件中配置，或setting界面配置相关参数，主要配置的就是触发快捷键、作者、邮箱等。也可以在setting.json中配置自定义分格的注释。
下面贴上自己配置的注释风格。（注意，自定义的风格里面，有显示内容限制，可以参考setting界面的说明）

"doxdocgen.generic.authorEmail": "xxx@163.com",
    "doxdocgen.generic.authorName": "xxx",
    "doxdocgen.file.copyrightTag": [
        
        "@copyright Copyright (c) {year} , All Rights Reserved. ",
    
    ],
    "doxdocgen.file.customTag": [

        "**********************************************************************",
    ],

    "doxdocgen.file.fileOrder": [
        "custom",
        "file",
        "author",
        "version",
        "date",
        "brief",
        "copyright",   
        "empty", 
        "custom" 
    ],
    "doxdocgen.generic.customTags": [
        
        "**********************************************************************",
    ],
    "doxdocgen.generic.order": [
        "custom",
        "brief",
        "param",
        "return",
        "custom",

    ],
    "doxdocgen.generic.paramTemplate": "@param {param} comment ",
    "doxdocgen.generic.returnTemplate": "@return {type} comment",

    // 触发快捷键
    "doxdocgen.c.triggerSequence": "///",