一款文檔生成工具:Doxygen生成

什么是Doxygen?

生成文檔使用教程

1、安裝

doxywizard使用步驟

doxywizard使用步驟

工作目錄如下：

.
├──out
└── src
└── math.h

其中math.h代碼如下：

/*! file math.h */

/*!
用于求一個(gè)角度的sin值，輸入是字符串以便同時(shí)支持弧度制和角度制表示
li 弧度制用pi表示，例如：2pi表示一圈、0.5pi表示直角
li 角度制用d結(jié)尾，例如：360d表示一圈、90d表示直角
li 輸入也可以是數(shù)值，例如：輸入3.14159大約表示180度

param a 用弧度制或角度制表示都行，字符串必須用'?'表示結(jié)束
param[out] res 是輸出參數(shù)，用于保存sin運(yùn)算的結(jié)果


eturn 錯(cuò)誤碼，0表示成功，其它表示失敗

	odo 在xxx的情況下存在BUG，預(yù)計(jì)下一版本修復(fù)
*/
intsin(char*a,double*res);

HTML界面

保存Doxyfile配置文件

為代碼編寫(xiě)注釋

1.什么樣的注釋會(huì)被Doxygen識(shí)別？

/**
* ... text ...
*/

/*!
* ... text ...
*/

///
/// ... text ...
///

//!
//!... text ...
//!

/*! file math.h */

https://www.doxygen.nl/manual/doxygen_usage.html

為其它編程語(yǔ)言生成注釋

-- file lmath.h

--[[    用于求一個(gè)角度的sin值，輸入是字符串以便同時(shí)支持弧度制和角度制表示    

li 弧度制用pi表示，例如：2pi表示一圈、0.5pi表示直角    

li 角度制用d結(jié)尾，例如：360d表示一圈、90d表示直角    

li 輸入也可以是數(shù)值，例如：輸入3.14159大約表示180度

    param a 字符串類型，表示角度，用弧度制或角度制表示都行
    
eturn 返回sin運(yùn)算的結(jié)果

    	odo 在xxx的情況下存在BUG，預(yù)計(jì)下一版本修復(fù)--]]function sin(a)    return 1.123end