doxygen注释规范示例（C++版）

最新推荐文章于 2024-07-07 21:10:32 发布

5C_King

最新推荐文章于 2024-07-07 21:10:32 发布

阅读量2.3k

点赞数

分类专栏：文档生成工具文章标签： doxygen文档生成工具注释方法

本文链接：https://blog.csdn.net/u013639526/article/details/31382273

版权

本文档详细介绍了如何使用doxygen为C++源文件和头文件编写注释，包括函数、文件、结构体、枚举类型的描述，帮助开发者生成高质量的API文档。

摘要由CSDN通过智能技术生成

源文件——函数注释

///@brief 函数名称：setProName
///@todo 代码实现的功能: 设置工区名称
///@param 参数：QWidget*
///@return 说明：int
///@retval 1. true 名字设置成功  (返回值说明(可选))
///@retval 2. false 名字设置失败
///@bug 此处的bug描述: 无
bool MainWindow::setProName(QString name)
{
}

头文件——文件描述，结构体描述，枚举类型描述，函数描述

#ifndef MAINWINDOW_H
#define MAINWINDOW_H

///@file mainwindow.h
///@brief 概述：doxygen使用文档
///
///详细介绍了doxygen的C++注释方法
///文件的注释方法为
///
///@author 作者：clover 邮箱：clover@123.com
///@version 版本号v1.0
///@date 日期：20140613
///@see MainWindow 本函数参考其它的相关的函数，这里作一个链接
///@note 描述需要注意的问题

///@brief 结构体
struct struct_variable
{
    int a;///<variable a
    int b;///<variable b
};

///@enum 性别枚举
enum SEX
{
    male,///<enum male
    female///<enum fem