C++ 注释
提示
- 注释的作用:C++中的注释是程序员添加的用以提高代码可读性 和易理解性的提示,它们在编译时会被完全忽略。
- 单行和多行注释:单行注释以
//
开头,用于简短说明;多行注释由/*
和*/
包裹,适用于长段说明。 - 调试和代码解释:注释可用于调试(通过注释掉代码阻止其执行),也应用于解释代码意图而非替代可读性差的代码。一般而言,注释应说明为什么做某事,而非如何做。
C++ 注释是程序员可以添加的提示,用来使代码更易阅读和理解。它们会被 C++ 编译器完全忽略。
向代码中添加注释有两种方法:
//
- 单行注释
/* */
- 多行注释
单行注释
在 C++ 中,任何以 //
开头的行都是注释。例如,
// 声明一个变量
int a;
// 用值 2 初始化变量 'a'
a = 2;
这里,我们使用了两个单行注释:
// 声明一个变量
// 用值 2 初始化变量 'a'
我们也可以这样使用单行注释:
int a; // 声明一个变量
多行注释
在 C++ 中,任何位于 /*
和 */
之间的行同样是注释。例如,
/* 声明一个变量
用于存储员工工资
*/
int salary = 2000;
这种语法可以用于编写单行或多行注释。
使用注释进行调试
注释也可以用来禁用代码,防止其被执行。例如,
#include <iostream>
using namespace std;
int main() {
cout << "一些代码";
cout << ''错误代码;
cout << "其他代码";
return 0;
}
如果在运行程序时出现错误,我们可以用注释来禁用可能出错的代码,而不是删除它;这可以是一个宝贵的调试工具。
#include <iostream>
using namespace std;
int main() {
cout << "一些代码";
// cout << ''错误代码;
cout << "其他代码";
return 0;
}
专业提示: 记住使用注释的快捷方式;这可能非常有用。对于大多数代码编辑器,Windows 是 Ctrl + /
,Mac 是 Cmd + /
。
为什么使用注释?
如果我们在代码中写下注释,将来理解代码会更容易。此外,对您的同事来说理解代码也会更容易。
注意: 注释不应该替代用英语解释糟糕编写的代码的方法。我们应该始终编写结构良好、自解释的代码。然后使用注释。
一般来说,使用注释来解释你为什 么这样做,而不是你如何做的,就可以了。