doxygen笔记1--c文件，pc文件注释

 

按照约定的格式注释源代码，用工具处理注释过的源代码产生文档。通过这种方式产生文档至少有以下好处：

• 便于代码和文档保持同步。
• 可以对文档做版本管理。

很多编程语言都有类似的文档工具，例如：Java有javadoc，Ruby有rdoc。对于C/C++程序，我们可以用Doxygen生成文档。

Doxygen比较适合制作API的接口文档，CHM是这类文档的常见格式。

 

学习目标：

学习doxygen约定的注释格式for “c” or “pc”；

编写各种模板方便公用和项目组推广使用。

生成对应的联机文档。

生成doxygen的使用心得及其问题集。

常用doxygen指令：

 * @brief 对于文件的简单注释
* @details 对于文件的详细注释
* @addtogroup example 范例
* @author Alex.shi
* @version 0.01
* @date 2010/05/25