在本教程中,我们将学习C ++注释,为什么使用它们以及如何在示例的帮助下使用它们。
C ++注释是程序员可以添加的代码提示和功能说明,以使他们的代码更易于阅读和理解。注释会被C ++编译器完全忽略。
有两种向代码添加注释的方法:
// -单行注释
/* */ -多行注释
在C ++中,任何以开头的行//都是注释。例如,
// 声明一个变量 int a; // 用值2初始化变量'a' a = 2;
在这里,我们使用了两个单行注释:
//声明一个变量
//用值2初始化变量'a'
我们也可以这样使用单行注释:
int a; // 声明一个变量
在C ++中,/*和*/之间的任何一行也是注释。例如,
/* 声明一个变量salary 存储员工工资 */ 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 + /)。
如果我们在代码上写注释,那么将来我们会更容易理解代码。而且,协作其他开发人员将更容易理解项目代码。
注意:注释不应该代替用英语解释写得不好的代码的方法。我们应该总是编写结构良好和自解释的代码。然后使用注释。
作为一般的经验法则,请使用注释来解释为什么您做了某件事,而不是您如何做某件事。