[閒聊] Doxygen part.1
為了幫助實驗室產生程式的文件檔案
所以老師使用Doxygen這個工具
Windows版下載連結 包括GUI介面
(看Magulo使用 GUI還不賴 :P)
http://ftp.stack.nl/pub/users/dimitri/doxygen-1.5.1-p1-setup.exe
安裝好就可以使用 不過還是要先把註解寫好
Manual連結:ftp://ftp.stack.nl/pub/users/dimitri/doxygen_manual-1.5.1.pdf.zip
註解的格式
基本上 每個檔案的開頭要有檔案的敘述
如果缺了這段 Doxygen 在File頁面就會忽略這個檔案
基本模式
/**
* @file
*/
or
/** @file */
這是當你什麼都不想寫的時候用的 XD
/** @file file_name
* @brief The brief description about this file
* (empty line)
* Detailed Description about this file.
* blah blah blah.
* etc. etc. etc.
* @author Name
*/
通常要寫成這樣
file_name 可以不加
@brief 是簡明的說明 通常都要寫
@brief 的下一行最好是空行 這樣比較不會出錯
空行之後就是Detail Description
@author 通常要寫一下
至於每個Class宣告前要有Class的敘述
/**
* @brief Brief description
*
* A test Class.
*/
class test {
public:
/**
* @brief Brief Description of val1
*
* Detailed Description of val1
*/
int val1;
/**
* Detailed Description of val2
*/
int val2; ///< Brief Description of val2
}
Doxygen的注解都是要寫在code的前面
但是class attributes 可以用 ///< 的語法寫在後面
若有比較多行 就用
/**<
Brief Description
*/
方便大家使用
每個Function前面也要有註解
/**
* @brief Brief
*
* Detail....
* ...
* @param a - first integer to be added
* @param b - second integer to be added
* @return a + b
* @retval 100 a+b = 100
*/
void test_function( int a, int b) {
return a + b;
}
簡介一下各個功能
@param
格式為 @param arg_name 參數說明
主要用於函式說明中，後面接參數的名字，然後再接關於該參數的說明。
@return
後面接函數傳回值的說明。用於function的註解中。說明該函數的傳回值。
@retval
格式為 @retval value 傳回值說明
主要用於函式說明中，說明特定傳回值的意義。所以後面要先接一個傳回值。然後再
放該傳回值的說明。
--
※ 發信站: 批踢踢實業坊(ptt.cc)
◆ From: 140.112.4.240