2012-02-19 66 views
0

我使用Doxygen來記錄我的C++代碼。所有的都以HTML格式輸出,除了像下面這樣的屬性/變量不是(完全沒有)。變量沒有記錄使用Doxygen

/** 
    * Flag to check whether the variable is once initialized or not 
    */ 
    bool initialized_; 

任何想法可能出錯?

EDIT

initialized_是一個類的成員變量。

回答

2

我不確定這是否能解決您的問題,因爲您已經提供了關於變量initialized_(它是一個全局變量,它是否爲類的一部分等)的很少信息,但doxygen documentation(參見下在其他地方)標題文檔指出

文件A C++類的成員,還必須記錄類本身。命名空間也是一樣。要記錄全局C函數,typedef,枚舉或預處理器定義,必須首先記錄包含它的文件(通常這將是頭文件,因爲該文件包含導出到其他源文件的信息)。

讓我們重複一遍,因爲它經常被忽略:要記錄全局對象(函數,typedefs,枚舉,宏等),必須記錄它們在其中定義的文件。換句話說,必須至少在此文件中的

/*! \file */ 

/** @file */ 

線。

+0

你的意思是應該在標題(界面)或我的實現文件中包含此行。它仍然沒有打印。 – 2012-02-20 16:01:17

+0

該文檔非常清晰:如果該變量是全局對象,則其定義的文件必須記錄(使用'\ file')。如果變量是類的成員,則該類本身必須定義。既然你更新了你的問題,所以聲明'initialised_'是一個類成員,你記錄了那個類嗎? – Chris 2012-02-20 18:33:38

+0

你的意思是在課前聲明之前,我通過把'@ brief','@ param'等文件記錄下來?如果你的意思是,我已經做到了。 – 2012-02-20 19:29:44