C++ 注释(Comments)
注释是程序中的非执行代码,用于提高代码的可读性,帮助开发者理解代码逻辑。C++ 支持 单行注释 和 多行注释。
1. 单行注释(Single-line Comments)
单行注释使用 // 开头,适用于简短的说明。
#include <iostream>
int main() {
// 输出 "Hello, C++!"
std::cout << "Hello, C++!" << std::endl;
return 0;
}
特点:
- 适用于简短的注释。
//之后的内容都会被编译器忽略。- 不能跨多行。
2. 多行注释(Multi-line Comments)
多行注释使用 /* ... */ 进行包裹,可用于大段注释。
#include <iostream>
int main() {
/*
这是一段多行注释
下面的代码会输出 "Hello, C++!"
*/
std::cout << "Hello, C++!" << std::endl;
return 0;
}
特点:
- 可用于大段注释,跨多行。
/*之后的所有内容都会被忽略,直到*/结束。- 不能嵌套使用(标准 C++ 不支持
/* ... /* ... */ ... */这样的嵌套注释)。
3. 注释的实际应用
3.1 代码调试
注释可用于临时禁用代码:
#include <iostream>
int main() {
std::cout << "Hello, C++!" << std::endl;
// std::cout << "这行代码暂时不执行" << std::endl;
return 0;
}
3.2 解释复杂代码
#include <iostream>
/* 计算两个整数的和
@param a: 第一个整数
@param b: 第二个整数
@return: a 和 b 的和
*/
int add(int a, int b) {
return a + b;
}
int main() {
int result = add(5, 3); // 调用 add() 函数计算 5 + 3
std::cout << "结果: " << result << std::endl;
return 0;
}
4. Doxygen 文档注释
C++ 代码通常使用 Doxygen 进行文档化,Doxygen 支持特殊的注释格式:
/**
* @brief 计算两个整数的和
* @param a 第一个整数
* @param b 第二个整数
* @return 返回 a 和 b 的和
*/
int add(int a, int b) {
return a + b;
}
这种注释形式适用于自动生成文档,如 API 说明文档。
5. 总结
| 注释类型 | 语法 | 适用场景 |
|---|---|---|
| 单行注释 | // 这是一个注释 | 短语句、变量说明 |
| 多行注释 | /* 这是一个多行注释 */ | 代码块、复杂逻辑说明 |
| Doxygen 注释 | /** 注释内容 */ | 生成文档、API 说明 |
最佳实践: 使用简洁、清晰的注释,避免过度注释。