Doxygen C++注释规范
来源:互联网 发布:淘宝会员等级表 编辑:程序博客网 时间:2024/06/08 08:25
Doxygen C++注释规范
一、
1
C++的注释风格主要使用下面这种样式:即在注释块开始使用三个反斜杠‘/’
其他地方其实与JavaDoc的风格类似,只是C++风格不用 “*” 罢了。
2
C++风格的简述与详述方式与javaDoc类似。一般注释的描述由简述开始,经过特殊分隔方式后,后面紧跟详述的内容,C++风格可以使用的分隔方法有以下两种:
(1)使用 \brief 参数标识,空行作为简述和详述的间隔标识
///
///
///
///
(2) 使用以空行(或者小数点加空格)作为简述与详述的分割
///
///
///
///
以小数点加空格作为分隔如下:
///
///
///
///
3
1.一个代码块(类、函数、结构等)的概述采用单行的”///”加一个空格开头的注释,并写在该代码块声明的前面;
4
///
///
///
///
///@file
/// @brief
///
///(本文件实现的功能的详述)
///
/// @version1.1
///@author
///@date
///
///
///
//////////////////////////////////////////////////////////////////////////
5
///
///
///
///
class CPrintError
{
}
6
(1)在成员变量上面加注释的格式
int
(2)在成员变量后面加注释的格式
int
7
/// 下面是一个含有两个参数的函数的注释说明(简述)
///
///
///
///
///
///
///
int testMe(int a,constchar *s);
8
///
///
///
///
enumTEnum
{
}enumVar;
9
(1)Doxygen会忽略你在注释中加入的多余的换行,如果你希望保留两行注释之间的空行,那么,在该行加入 \n
- Doxygen注释规范
- Doxygen C++注释规范
- Doxygen注释规范
- [总结]doxygen的使用与C/C++注释规范
- doxygen的使用与C/C++注释规范
- 了解doxygen的注释规范
- C/C++ doxygen注释示例
- C-Style Doxygen注释格式
- 符合doxygen规范的文档注释
- 符合Doxygen规范的注释宏ForVS2005
- doxygen注释规范示例(C++版)
- doxygen使用与C++注释规范
- doxygen的文档生成,注释规范
- C++注释Doxygen工具,注释的一般规范
- 嵌入式C语言中的Doxygen注释模板
- Doxygen:类C语言的注释块
- 嵌入式C语言中的Doxygen注释模板
- 基于Doxygen的C/C++注释原则
- Java/Android引用类型及其使用分析
- MySQL学习(一)加强
- Java并发编程:volatile关键字解析
- php动态生成图片实现浏览器缓存
- Android 提取硬编码字符串 setText (python脚本)
- Doxygen C++注释规范
- Hive扩展功能(六)--HPL/SQL(可使用存储过程)
- JAVA的IO操作
- 多线程---线程池总结
- mac上搭建php工作环境
- Redis内部原理
- cocoapods安装第三方库
- OOP面向对象三大特点
- row_number() OVER(PARTITION BY)函数介绍