C++ 注释

预计时间: 3分钟

在本教程中,我们将通过示例了解 C++ 注释、使用它们的原因以及如何使用它们。

C++ 注释是程序员可以添加的提示,以使他们的代码更易于阅读和理解。它们被 C++ 编译器完全忽略。

有两种方法可以在代码中添加注释:

  • // 单行注释
  • /* */ 多行评论

单行注释

在 C++ 中,任何以//开头的行都是注释。例如,

// 声明一个变量
int a;

// 初始化一个变量 a 的值为 2
a = 2;

在这里,我们使用了两个单行注释:

  • // 声明一个变量
  • // 初始化一个变量 a 的值为 2

我们也可以像这样使用单行注释:

int a;    // 声明一个变量

多行注释

在 C++ 中,/**/之间的任何行也是注释。例如,

/* 声明一个变量
存储员工工资
*/
int salary = 2000;

此语法可用于编写单行和多行注释。

使用注释进行调试

注释也可用于禁用代码以防止其被执行。例如,

#include <iostream>
using namespace std;
int main() {
   cout << "some code";
   cout << ''error code;
   cout << "some other code";

   return 0;
}

如果我们在运行程序时遇到错误,我们可以使用注释来禁止执行,而不是删除容易出错的代码;这可能是一个有价值的调试工具。

#include <iostream>
using namespace std;
int main() {
   cout << "some code";
   // cout << ''error code;
   cout << "some other code";

   return 0;
}

专业提示:记住使用注释的快捷方式;这真的很有帮助。对于大多数代码编辑器,Windows 快捷键是Ctrl + /,Mac是 Cmd + /

为什么要使用注释?

如果我们在我们的代码上写注释,将来我们更容易理解代码。此外,其他开发人员也将更容易理解代码。

注意:注释不应该成为解释糟糕代码的一种方式。我们应该总是编写结构良好、不言自明的代码。然后才使用注释。

作为一般的经验法则,使用注释来解释你为什么做某事,而不是你如何做某事。

更新于2021年05月04日