doxygen相关问题-飞翔的专栏-csdn博客.pdf

5 Doxygen的注释风格 5 Doxygen的注释风格 55 DDooxxyyggeenn的的注注释释风风格格 5.1 综述 5.1 综述 55..11 综综述述 在每个代码项中都可以有两类描述, 这两类描述将在文档中格式化在一起: 一种就是brief描述, 另一种就是detailed。 两种都是可选的，但不能同时没 有。 顾名思义, 简述(brief)就是在一行内简述地描述。而详细描述(detailed d escription)则提供更长, 更详细的文档。 Doxygen支持c风格注释、c++风格注释以及javaDoc风格注释等，下 面将分别予以介绍。 若需要通过Doxygen生成漂亮的文档，一般有如下几个地方需要使用Doxyg en支持的风格进行注释： 1） 文件头（包括.h和.cpp） 主要用于声明版权，描述本文件实现的功能，以及文件版本信息等 2） 类的定义 主要用于描述该类的功能，同时也可以包含使用方法或者注意事项的 简要描述 3） 类的成员变量定义 在类的成员变量上方，对该成员变量进行简要地描述 4） 类的成员函数定义 在类定义的成员函数上方，对该成员函数功能进行简要描述 5） 函数的实现在函数的实现代码处，详细描述函数的功能、参数的含 义、返回值的含义、使用本函数需要注意的问题、本函数使用其他类或函数的 说明等 5.2 Doxygen支持的指令 5.2 Doxygen支持的指令 55..22 DDooxxyyggeenn支支持持的的指指令令 5.2.1 概述 5.2.1 概述 55..22..11 概概述述 可以在注释中加一些Doxygen支持的指令，主要作用是控制输出文档的 排版格式，使用这些指令时需要在前面加上“\”或者“@”（JavaDoc风 格）符号，告诉Doxygen这些是一些特殊的指令，通过加入这些指令以及配 备相应的文字，可以生成更加丰富的文档，下面对比较常用的指令做一下简单 介绍。 5.2.2 常用指令介绍 5.2.2 常用指令介绍 55..22..22 常常用用指指令令介介绍绍 @file 档案的批注说明。 @author 作者的信息 @brief 用于class 或function的简易说明 eg： @brief 本函数负责打印错误信息串 @param 主要用于函数说明中，后面接参数的名字， 然后再接关于该参数的说明 @return 描述该函数的返回值情况 eg: @return 本函数返回执行结果，若成功则返 回TRUE，否则返回FLASE @retval 描述返回值类型 eg: @retval NULL 空字符串。 @retval !NULL 非空字符串。 @note 注解 @attention 注意 @warning 警告信息 @enum 引用了某个枚举，Doxygen会在该枚举处产 生一个链接 eg： @enum CTest::MyEnum @var 引用了某个变量，Doxygen会在该枚举处产 生一个链接