C++ 注释
C++ 注释
什么是注释
注释是在程序中加入的用于说明代码的文字,它不会被编译器编译和执行,仅供程序员参考。注释包括单行注释和多行注释。
单行注释
单行注释以两个斜杠(//)开头,后跟注释文字,可以放在行尾或行内。行尾注释的语法如下:
int a = 0; // a 是一个整数
行内注释的语法如下:
int a = 0; // a 是一个整数
多行注释
多行注释以斜杠和星号(/)开头,以星号和斜杠(/)结尾,中间为注释内容。多行注释不能嵌套,也不能跨行。
/*
a 是一个整数
b 是一个字符串
*/
int a = 0;
string b = "hello";
文档注释
文档注释是一种特殊的注释,用于生成文档。C++ 中常用的文档注释工具为 Doxygen。文档注释以两个星号(**)开头,后跟注释文字,可以放在类、函数、变量等的定义前。语法如下:
/**
* @brief 矩形类
*
* 该类用于表示一个矩形的信息。
*/
class Rectangle {
public:
/**
* @brief 构造函数
*
* @param a 矩形长
* @param b 矩形宽
*/
Rectangle(int a, int b);
/**
* @brief 计算矩形面积
*
* @return 矩形面积
*/
int area();
private:
int length; ///< 矩形长
int width; ///< 矩形宽
};
文档注释使用了特殊的注释标签(@brief、@param、@return 等),这些标签可以被 Doxygen 自动解析,生成高质量的文档。