c++ doxygen 注释规范_[总结]doxygen的使用与C/C++注释规范

近期由于项目需要，参考网上资料整理了一下注释规范，详细内容如下：

1.   doxygen的安装与参数配置

1.1.  安装

$ sudo apt-get install doxygen

以下可以选择安装

$sudo apt-get install doxygen-doc doxygen-gui graphviztexpower dot2tex graphviz-doc texpower-examples

1.2.  生成配置文件

在 shell 提示上，输入命令 doxygen -g。这个命令在当前目录中生成一个可编辑的配置文件 Doxyfile。可以改变这个文件名，在这种情况下，应该调用 doxygen -g

1.3.  修改配置参数

l：必须在这里提供一个目录名，例如 /home/user1/documentation，这个目录是放置生成的文档文件的位置。如果提供一个不存在的目录名，doxygen

会以这个名称创建具有适当用户权限的目录。

l：这个标记创建一个以空格分隔的所有目录的列表，这个列表包含需要生成文档的C/C++源代码文件和头文件。例如，请考虑以下代码片段：

INPUT = /home/user1/project/kernel /home/user1/project/memory

在这里，doxygen会从这两个目录读取 C/C++源代码。如果项目只有一个源代码根目录，其中有多个子目录，那么只需指定根目录并把标记设置为 Yes。

l：在默认情况下，doxygen会搜索具有典型 C/C++扩展名的文件，比如 .c、.cc、.cpp、.h 和 .hpp。如果标记没有相关联的值，doxygen就会这样做。如果源代码文件采用不同的命名约定，就应该相应地更新这个标记。例如，如果项目使用 .c86 作为 C文件扩展名，就应该在标记中添加这个扩展名。

l：如果源代码层次结构是嵌套的，而且需要为所有层次上的C/C++文件生成文档，就把这个标记设置为 Yes。例如，请考虑源代码根目录层次结构

/home/user1/project/kernel，其中有/home/user1/project/kernel/vmm 和/home/user1/project/kernel/asm 等子目录。如果这个标记设置为 Yes，doxygen 就会递归地搜索整个层次结构并提取信息。