C++注释


2022年8月3日, Learn eTutorial
2141

在本教程中,我们将学习 C++ 注释、为什么使用它们以及如何使用它们(附带示例)。

C++ 注释是程序员可以添加到代码中以使其更易于阅读和理解的建议。C++ 编译器会完全忽略它们。注释可用于解释和提高 C++ 代码的可读性。它还可用于在尝试不同的代码时阻止执行。

注释不应作为解释编写不佳的英文代码的替代方法。我们应该始终编写结构良好且自解释的代码。然后,使用注释。

为什么注释在编程中如此重要?

注释是插入到程序中以解释源代码的文本注释。它们在编程语言中用于记录程序并提醒程序员他们刚刚对代码所做的棘手事情。它们还有助于后代理解和维护代码。

添加注释主要有两种方法

  1. // - 单行注释
  2. /* */ - 多行注释

C++ 中的单行注释是什么?

//(两个斜杠)字符,后跟任何字符序列。这种注释以不紧跟反斜杠的新行终止。因此,它主要被称为“单行注释”。


// comment
 

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

例如,


// declaring a variable
int a;

// here we are initializing the variable 'a' with the value 5
a = 5;
 

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

  •    // 声明一个变量
  •   // 这里我们将变量 'a' 初始化为值 5

代码行末尾的注释

您也可以在代码行的末尾添加注释。但是,通常最好将注释放在代码行之前。下面给出的示例适用于 C 和 C++,因为这两种语言的注释风格相同。

我们也可以使用单行注释,例如


int a; // declaring a variable
 

C++ 中的多行注释是什么?

任何文本都可以表示为 /* 任何文本 */。以正斜杠和星号 (/*) 开头,以正斜杠和星号 (*/) 结尾。

它用于指示多行注释。可以将注释应用于多行。它被称为 C 风格注释,因为它最初在 C 编程中使用。


/*Comment starts
continues
continues
.
.
.
Comment ends*/

 

C++ 中 /* 和 */ 之间的任何行也都是注释。

例如


/* C++ program  in order to illustrate
use of
multi-line comment */
#include <iostream>
int main()
{
 /* Multi-line  will Welcome user comment
 written to demonstrate comments
 in C++ */
 std::cout << "Welcome to learn eTutorials";
 return 0;
}

// This code is contributed by lasepra123
 

输出


Welcome to learn eTutorials

如何使用注释进行调试?

注释也可以用来禁用代码,使其不被执行。

例如,


#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;
}
}

注释可用于多种目的,包括

  1. 用于规划和审查: 我们可以在注释中写入我们计划在编写源代码之前编写的伪代码。伪代码是一种结合了自然语言和高级编程的语言。这使得审查源代码变得更容易,因为伪代码比程序更容易理解。
  2. 代码描述: 程序员使用代码描述来帮助他人理解他或她的意图。它包含代码的摘要。
  3. 用于算法解释: 注释用于解释方法。图表和形式数学证明就是这种解释的例子。这可以解释为对代码的解释,而不是对其意图的澄清。例如,程序员可能包含一条注释,解释为什么选择插入排序而不是快速排序,因为前者在理论上是如此。
  4. 用于资源包含: 由 ASCII 艺术构造组成的徽标、图表和流程图可以作为注释格式插入到源代码中。此外,版权声明可以作为注释嵌入到源代码中。
  5. 元数据: 程序的元数据也包含在注释中。此元数据对于软件维护很有用。元数据包括原始版本创建者的姓名、程序的当前维护者、第一个版本创建的日期、迄今为止编辑过程序文件的人员姓名等。
  6. 调试:一种常见的调试方法是暴力破解。在此方法中,打印语句插入到整个程序中,以打印中间值,希望能有一些打印值有助于识别错误。调试后,我们注释掉这些打印语句。因此,注释也用于调试。
  7. 自动文档生成:文档和元数据有时由编程工具存储在注释中。这些还可能包括用于自动包含头文件的插入位置、用于更改文件语法高亮模式的命令或文件的修订号。这些功能控制注释也称为注解。简化文档过程并提高其更新以反映代码更改的可能性的一种策略是将文档保留在源代码注释中。
  8. 缓解压力: 通过评论开发工具、竞争对手、雇主、工作条件或代码本身的质量,可以缓解压力。这种现象很容易通过跟踪源代码中脏话的在线资源来发现。