QDoc API 文档示例

QDoc API 文档示例

在代码的开发过程中，为了更好地维护和管理代码，我们通常需要编写相应的 API 文档。而 QDoc 是 Qt 框架提供的一种基于注释的文档生成工具，可以帮助我们方便地生成 API 文档。

下面我们就来演示一下如何使用 QDoc 编写 API 文档。

首先，我们需要在代码中添加相应的注释，这些注释将用于生成 API 文档。例如，我们编写了以下代码：

/**
 * @brief 这是一个加法函数
 * 
 * @param a 加数
 * @param b 加数
 * @return int 两数之和
 */
int add(int a, int b)
{