源檔案——函數注釋
///@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