doxygen用法整理

官方资料:

http://www.stack.nl/~dimitri/doxygen/results.html

http://www.stack.nl/~dimitri/doxygen/projects.html

 

doxygen输入输出编码列表

http://www.gnu.org/software/libiconv/

 

在vs中使用doxygen的资料

 

http://www.codeproject.com/KB/tips/doxysetup.aspx

10 Minutes to document your code

 

doxygen在实际工程中的基础用法, 不是很多. 稍后整理.

 

doxygen1.7.1(2010/09/30)对中文支持的相当好, 也许是以前编码设置的不对.

doxygen设置

 

 

函数注释模板

/** * @name fixCodeVeify * @param PBYTE pBuf 纠错编码的Buffer * @param DWORD dwLen 纠错编码Buffer的长度 * @param DWORD & dwLenOriginalBuf 纠错后, 原始码的长度 * @return DWORD * @retval S_OK 成功 * @retval S_FALSE 失败 * @note * 1. 纠错在原来的pBuf上进行, 无论结果对错, 原来的pBuf都变了/n * 2. 纠错后, 如果正确, 必然是(dwLenOriginalBuf < dwLen)/n * @note * /n * 传入的字节流格式: /n * (字节流总长度)DWORD dwLenTotal+ /n * (校验和总长度)DWORD dwLenVerifyStreamTotal+ /n * (校验和方法, 目前只接受MD5)DWORD dwVerifyMethod + /n * (校验和字节流) BYTE szVerifyStream[] + /n * (数据长度)DWORD dwLenDataStream + /n * (数据字节流) BYTE szDataStream[] /n */ int fixCodeVeify(PBYTE pBuf, DWORD dwLen, DWORD & dwLenOriginalBuf);

效果

 

 

doxygen语法: /**< xx */

含义: 注释紧跟在被注释项下面, 适用于枚举值, 变量, 函数

 

对于函数的注释, 因为有入参，出参，返回值. 还是用函数注释模板的用法贴切

 

编码者信息注释模板

/** @class CLsLogger * @brief 日志记录类 * @author LostSpeed * @version 1.0.0.1 * @date 2010/10/09 * @bug 暂时没有测出严重bug * @warning Log性能还有待提高 */

效果

文件信息注释模板

/** @file LsLogger.h @brief 日志记录类的头文件 */

效果

 

doxygen/examples中的注释的基础用法，我觉得就这些, 平时顺手把代码文档化，够用了。

其他的例子, 美化和组织doxygen文档的用意更多.

 

<2011_0120>

google下面的关键句，可以看到有些资料。没来的及看。

"Your Code is Not Self Documenting"