doxygen C++

Doxygen常用注释命令

@exception {exception description} 对一个异常对象进行注释。

@warning {warning message } 一些需要注意的事情

@todo { things to be done } 对将要做的事情进行注释,链接到所有TODO 汇总的TODO 列表

@bug 缺陷,链接到所有缺陷汇总的缺陷列表

@see {comment with reference to other items } 一段包含其他部分引用的注释,中间包含对其他代码项的名称,自动产生对其的引用链接。

@relates 通常用做把非成员函数的注释文档包含在类的说明文档中。

@since {text} 通常用来说明从什么版本、时间写此部分代码。

@deprecated

@pre { description of the precondition } 用来说明代码项的前提条件。

@post { description of the postcondition } 用来说明代码项之后的使用条件。

@code 在注释中开始说明一段代码,直到@endcode命令。

@endcode 注释中代码段的结束。

@code … @endcode 包含一段代码

@addtogroup 添加到一个组。

@brief 概要信息

@deprecated 已废弃函数

@details 详细描述

@note 开始一个段落,用来描述一些注意事项

@par 开始一个段落,段落名称描述由你自己指定

@param 标记一个参数的意义

@fn 函数说明

@ingroup 加入到一个组

@return 描述返回意义

@retval 描述返回值意义

@include 包含文件

@var、@enum、@struct、@class 对变量、美剧、结构体、类等进行标注

Latex

行内公式,使用\f$

The distance between \f$(x_1,y_1)\f$ and \f$(x_2,y_2)\f$ is  
\f$\sqrt{(x_2-x_1)^2+(y_2-y_1)^2}\f$.

行间公式,即公式单独成一行,使用\f[\]f

\f[  
|I_2|=\left| \int_{
   0}^T \psi(t)  
\left\{
     
u(a,t)-  
\int_{
   \gamma(t)}^a  
\frac{
   d\theta}{
   k(\theta,t)}  
\int_{
   a}^\theta c(\xi)u_t(\xi,t)\,d\xi  
\right\} dt  
\right|  
\f] 

使用environment,以 \f{environment}开始,以\f}结尾

\f
  • 1
    点赞
  • 2
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
Doxygen 是一款用于生成 C++ 代码文档的工具。它可以根据程序源代码中特定的注释格式自动生成文档,包括类、函数、变量等的说明和使用方法,使得代码文档更加规范和易于维护。 以下是使用 Doxygen 生成 C++ 代码文档的步骤: 1. 安装 Doxygen 工具。可以从 Doxygen 官网上下载安装包,并按照相应的操作系统进行安装。 2. 在 C++ 源代码中添加特定的注释格式,以便 Doxygen 工具能够识别并生成文档。例如: ``` /** * @brief 该函数用于计算两个整数的和 * * @param a 第一个整数 * @param b 第二个整数 * @return 两个整数的和 */ int add(int a, int b) { return a + b; } ``` 3. 配置 Doxygen 工具。可以通过在 Doxygen 安装目录下找到并运行 doxygen 命令来打开配置向导,或者手动编辑配置文件。需要设置源代码目录、输出目录、文档格式等配置项。 4. 运行 Doxygen 工具。可以通过在命令行中执行 doxygen 命令来生成文档,或者通过 Doxygen 工具提供的 GUI 界面来操作。生成的文档会保存在指定的输出目录中。 5. 查看生成的文档。使用浏览器打开生成的文档首页,即可浏览和查看代码文档。 以上是使用 Doxygen 生成 C++ 代码文档的基本步骤。需要注意的是,注释格式必须符合 Doxygen 的要求,否则可能无法生成正确的文档。同时,注释中应该包含足够的信息,以便其他人能够理解和使用代码。

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值