Doxygen文档系统简单使用

发表于

按照规范的格式注释源代码,用工具处理注释过的源代码产生文档.便于代码和文档保持同步,可以对文档做版本管理.

注释风格

1
2
3
4
5
6
/**
 *  ...多行注释...
 *
 */
 
/** ...单行注释... */

文件注释

1
2
3
4
5
6
7
8
9
10
11
12
13
/**
 * @file xxx
 * @author xxx
 * @version xxx
 * @date xxxx/xx/xx
 *
 * @section LICENSE
 *
 * Copyright(c) yyyy-yyyy XXX
 * All rights reserved
 * 
 * @brief xxx
 */

函数注释

1
2
3
4
5
6
7
8
/** 
 * @brief xxx
 * @param[in] param1 param2
 * @param[out] param1 param2
 * @return xxx
 * @retval true success
 * @retval false failed
 */

一般简易注释

1
2
3
/**
 * @brief xxx
 */