type
status
date
slug
summary
tags
category
icon
password
文章筛选
以下是常见的 Doxygen 注释标记的表格，包括它们的功能和说明：
标记 | 功能 | 说明 |
@file | 描述整个源文件 | 描述整个源文件的内容和作用 |
@brief | 提供简要描述 | 描述函数、类或成员的简要说明 |
@param | 描述函数参数 | 描述函数的参数名称和用途 |
@return | 描述返回值 | 描述函数的返回值的含义 |
@retval | 函数返回值的特定取值说明 | ㅤ |
@see | 引用相关文档或代码元素 | 创建超链接到其他文档或资源 |
@note | 提供额外的注释或注记 | 提供额外的相关信息或注记 |
@warning | 指示潜在问题或警告 | 指示潜在的问题或需要注意的警告 |
@deprecated | 标记已弃用的代码元素 | 标记代码元素已被弃用，不推荐使用 |
@code | 标记代码示例的开始 | 将注释内的文本标记为代码示例的开始 |
@endcode | 标记代码示例的结束 | 结束 @code 块，代码示例的结束 |
@class | 描述类 | 描述类的内容和作用 |
@struct | 描述结构体 | 描述结构体的内容和作用 |
@enum | 描述枚举类型 | 描述枚举类型的内容和作用 |
@fn | 描述函数 | 描述函数的内容和作用 |
@var | 描述变量 | 描述变量的内容和作用 |
@typedef | 描述类型定义 | 描述类型定义的内容和作用 |
@example | 提供代码示例 | 提供一个代码示例，展示使用方法 |
@todo | 标记待办事项 | 标记待办事项或未完成的工作 |
@internal | 指示内部代码元素 | 指示内部代码元素，不会出现在生成的文档中 |
@link | 创建超链接 | 创建一个超链接到其他文档或资源 |
@mainpage | 标记为主页 | 标记为整个文档的主页，作为入口点 |
@defgroup | 创建模块分组 | 将相关的类、函数或变量分组为一个模块 |
@addtogroup | 添加到现有模块分组 | 将代码元素添加到现有的模块分组中 |
@par | 创建段落 | 创建一个段落，提供特定的使用指南、示例等 |
@namespace | 描述命名空间 | 描述命名空间的内容和作用 |
@anchor | 创建命名的锚点，用于在文档内部进行跳转 | ㅤ |
@ref | 引用锚点或其他文档元素，创建内部跳转链接 | ㅤ |
github
- 作者:也平凡
- 链接:https://www.990001.xyz/blog/doxygen
- 声明:本文采用 CC BY-NC-SA 4.0 许可协议，转载请注明出处。
