嵌入式C语言中的Doxygen注释模板
来源:互联网 发布:类似filezilla的软件 编辑:程序博客网 时间:2024/06/10 04:28
嵌入式C语言开发中通常使用Doxygen进行文档的生成。Doxygen支持多种格式,非常灵活,但排版不好就会显的比较杂乱,不便于阅读。下面给出一份注释模板。
一、文件注释,放于文件的开头
- /**
- * @file filename
- * @brief This is a brief description.
- * @details This is the detail description.
- * @author author
- * @date date
- * @version A001
- * @par Copyright (c):
- * XXX公司
- * @par History:
- * version: author, date, desc\n
- */
二、函数注释,放于函数声明前
- /**
- * This is a brief description.
- * This is a detail description.
- * @param[in] inArgName input argument description.
- * @param[out] outArgName output argument description.
- * @retval OK 成功
- * @retval ERROR 错误
- * @par 标识符
- * 保留
- * @par 其它
- * 无
- * @par 修改日志
- * XXX于201X-XX-XX创建
- */
三、数据结构注释,放于数据结构定义前
- /**
- * The brief description.
- * The detail description.
- */
- typedef struct
- {
- int var1;///<Description of the member variable
- }XXXX;
四、宏定义注释,放于宏定义上方或者右侧
- /** Description of the macro */
- #define XXXX_XXX_XX 0
或者
- #define XXXX_XXX_XX 0 ///< Description of the macro.
五、全局和静态变量注释
- /** Description of global variable */
- int g_xxx = 0;
- static int s_xxx = 0; ///< Description of static variable
- 嵌入式C语言中的Doxygen注释模板
- 嵌入式C语言中的Doxygen注释模板
- 嵌入式C语言中的Doxygen注释模板
- 嵌入式C语言中的Doxygen注释模板
- Doxygen:类C语言的注释块
- Doxygen注释模板
- c语言中的注释
- C/C++ doxygen注释示例
- C-Style Doxygen注释格式
- 一份 c++的DoxyGen 的注释模板
- 关于c语言中的注释
- C语言中的注释方法
- 基于Doxygen的C/C++注释原则
- 基于Doxygen的C/C++注释原则
- 基于Doxygen的C/C++注释原则
- 基于Doxygen的C/C++注释原则
- doxygen注释
- doxygen注释
- ciscoL3交换机配置命令
- iOS应用开发:什么是ARC?
- FTP数据包 协议分析
- Git基础概念
- SIP协议全方位概要介绍
- 嵌入式C语言中的Doxygen注释模板
- JSP————Page指令属性
- Object的notify及wait方法实例一则
- hdu4463
- 二级指针在函数中的应用(读取文件到BYTE*数组中)
- struts2 笔记
- hdu 1251 [Trie]
- Hibernate 缓存机制
- 编译器Clang介绍