C++注释和doxygen注释
2024-08-27 03:38:32
C++注释
C++的注释只有两种：
- 单行注释，以“//”开头；
- 段落注释，以“/*”开始，以“*/”结束。
int value; // value是一个整型变量，这是一句单行注释 /*
Test是一个测试用的类
这是一段注释中的一行
这是一段注释中的另一行
*/
class Test {
};
doxygen注释：记住下面3点语法规则就够了
参照上文C++注释的分类方式，doxygen注释可以这样划分：
- 前置单行注释，以“///”开头；
- 后置单行注释，以“///<”开头，紧跟代码后面；
- 段落注释，以“/**”开始，以“*/”结束。
doxygen注释不单止是给人看的，在生成文档的时候，程序需要根据约定的语法来识别注释和代码的相对位置，因此doxygen的单行注释可分为前置和后置两种：
/// value0是一个整型变量，这句注释在代码的前面
int value0; int value1; ///< value1是一个整型变量，这句注释在代码的后面
段落注释也可以分为前置和后置两种，但后置的段落注释意义不大，我反对同学们写后置的段落注释：
/**
Test是一个测试用的类
这是一段注释语句中的一行
这是一段注释语句中的另一行
*/
class Test {
};
examples\afterdoc.h
doxygen安装文件夹下的examples\afterdoc.h，内容如下：
/*! A test class */ class Test
{
public:
/** An enum type.
* The documentation block cannot be put after the enum!
*/
enum EnumType
{
int EVal1, /**< enum value 1 */
int EVal2 /**< enum value 2 */
};
void member(); //!< a member function. protected:
int value; /*!< an integer value */
};
采用上文的3个语法规则重新调整一下，是不是顿觉豁然开朗了呢？
/** A test class */
class Test
{
public:
/**
An enum type.
The documentation block cannot be put after the enum!
*/
enum EnumType
{
int EVal1, ///< enum value 1
int EVal2 ///< enum value 2
}; void member(); ///< a member function. protected:
int value; ///< an integer value
};
系列文章索引：http://www.cnblogs.com/duxiuxing/p/4301031.html
最新文章
- 解析大型.NET ERP系统 多国语言实现
- Dictionary读取键值的快捷方法
- 区间dp总结篇
- 图片上传功能<转>http://blog.csdn.net/u011159417/article/details/50126023
- centos55_oracle11gr2_install
- JAVA实现多线程入门
- windows8 开发教程 教你制作 多点触控Helper可将任意容器内任意对象进行多点缩放
- Redis的List操作
- oracle学习笔记（二）表的查询
- 转载【ViewPager+Fragment】ViewPager中切换界面Fragment被销毁的问题分析
- poj1655（树形dp）
- JavaScript采用append添加的元素错误
- Strtus2框架笔记
- Uva - 12504 - Updating a Dictionary
- 摹客iDoc的PS插件全新改版！—— 智能检测不对应的设计稿
- JXOI2018简要题解
- BigDecimal提供了8种舍入方式
- 第13月第13天 iOS 放大消失动画
- php从入门到放弃系列-04.php页面间值传递和保持
- 演示-JQuery中伪元素和伪类选择器