doxygen注释详解-附有生成文档的对照.pptVIP

par指令操作符讲解 par：指定扩展性说明指令操作符讲。（它一般跟code、endcode一起使用 ） par格式如下： @par 扩展名字 例: /** * 打开文件函数 * @Param [in] name 文件名 * @Param [in] “rb” 打开模式 * @return 返回文件编号 * - -1表示打开文件失败 * @par 示例: * @code //用文本只读方式打开文 int f = OpenFile(”c:\\test.txt”, “rb”); * @endcode */ int OpenFile(U8* file_name, U8* file_mode); code、endcode指令操作符讲解 code、endcode：指定 code、endcode格式如下： @code 简要说明(内容) @endcode 例: /** * 打开文件函数 * @Param [in] name 文件名 * @Param [in] “rb” 打开模式 * @return 返回文件编号 * - -1表示打开文件失败 * @par 示例: * @code //用文本只读方式打开文 int f = OpenFile(”c:\\test.txt”, “rb”); * @endcode */ int OpenFile(U8* file_name, U8* file_mode); see指令操作符讲解 see：指定参考信息。 see格式如下： @see 简要参考内容 例: /** *文件关闭函数 * @param file文件编号。 * @retval 0 表示成功 * @retval -1 表示失败 * @pre file 变量必须使用OpenFile 返回值 * @see 函数::OpenFile */ int CloseFile(int file); “::”是指定有连接功能.可以看文档里的OpenFile变成绿.点击它可以跳转到OpenFile. deprecated指令操作符讲解 deprecated：指定函数过时指令操作符。 deprecated格式如下： @deprecated 简要说明 例: /** *文件关闭函数 * @param file文件编号。 * @retval 0 表示成功 * @retval -1 表示失败 * @deprecated 由于特殊的原因,将来的版本中取消。 */ int CloseFile(int file); -、#、::指令操作符讲解 -：生成一个黑心圆. -#：指定按顺序标记。 ::：指定连接函数功能。（注：空格和“:”有连接功能,但建议还是使用”::”。只对函数有用。） 它们格式如下: (-和::例子前面有了,就介绍-#例子。) - 简要说明 -# 简要说明 ::函数名 例： /** * @param [in] p 只能输入以下参数： * -# a:代表一功能 * -# b:代表二功能 * -# c:代表三功能 */ Void Test_File(U8 p); 模块定义（单独显示一页 ） 模块定义格式: /** * @defgroup 模块名 页的标题名 * @{ */ … 定义的内容 … /** @} */ 例： /** * @defgroup aa ebo