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

源文件——函数注释

///@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 邮箱：[email protected]
///@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 female
};

#include <QMainWindow>

///@brief 主窗口
class MainWindow : public QMainWindow
{
    Q_OBJECT
    
public:
    MainWindow(QWidget *parent = 0);
    ~MainWindow();

    bool setProName(QString name);///< 设置工区名称

private:
    QString m_name;
};

#endif // MAINWINDOW_H