Cplusplus 简明教程

Comments in C++

C++ Comments

程序注释是可以包含在 C++ 代码中的解释性语句。这些注释有助于任何人阅读源代码。所有编程语言都允许某种形式的注释。

Types of C++ Comments

C 支持两种类型的注释： single-line comments 和 multi-line comments 。 C compiler 忽略任何注释中可用的所有字符。

C++ 注释类型在下一节中进行了详细解释：

1. C++ Single-line Comments

单行注释以 // 开头，一直延伸到行的末尾。这些注释只能持续到行的末尾，然后下一行将生成新的注释。

以下语法展示了如何在 C++ 中使用单行注释：

// Text to be commented

在以下示例中，我们正在创建单行注释 −

#include <iostream>
using namespace std;

int main() {
  // this is a single line comment
  cout << "Hello world!" << endl;
  // for a new line, we have to use new comment sections
  cout << "This is second line.";

  return 0;
}

Output

Hello world!
This is second line.

2. C++ Multi-line Comments

多行注释以 / 开头，以 / 结尾。这些符号之间的任何文本仅被视为注释。

以下语法显示了在 C++ 中使用多行注释的方法：

/* This is a comment */

/*
  C++ comments can also
  span multiple lines
*/

在以下示例中，我们创建多行注释 −

#include <iostream>
using namespace std;

int main() {
  /* Printing hello world!*/
  cout << "Hello World!" << endl;
  /*
  This is a multi-line comment
  Printing another message
  Using cout
  */
  cout << "Tutorials Point";

  return 0;
}

Output

Hello World!
Tutorials Point

Comments within Statements

我们还可以注释掉 C++ 程序中代码块内的特定语句。这两种类型的注释都能实现此目的。

Example

以下示例说明在语句中使用多行注释：

#include <iostream>
using namespace std;

int main() {
  cout << "This line" /*what is this*/ << " contains a comment" << endl;
  return 0;
}

Output

This line contains a comment

Example

以下示例说明在语句中使用单行注释：

#include <iostream>
using namespace std;

int main() {
  cout << "This line"  // what is this
       << " contains a comment" << endl;
  return 0;
}

Output

This line contains a comment

Nesting Comments

在 /* 和 / comment, // characters have no special meaning. Within a // comment, / 和 */ 中没有任何特殊含义。因此，你可以将一种类型的注释“嵌套”在另一种类型中。

Example

以下示例说明在注释中使用嵌套注释：

#include <iostream>
using namespace std;
int main() {
  /* Comment out printing of Hello World:

cout << "Hello World"; // prints Hello World

*/
  cout << "New, Hello World!";
  return 0;
}

Output

New, Hello World!

Single-line or Multi-line Comments - When to Use?

单行注释通常用于一般情况下的简短注释行。在代码中需要为算法说明提示时会使用这一点。

多行注释通常用于更长的注释行，其中整个注释行的可见性是必需的。注释的长度越长，多行注释需要更多条语句。

Purpose of Comments

注释在 C++ 中用于各种目的。一些注释的主要应用区域如下：

对程序中的一个简短而简洁的步骤进行注释，以帮助用户更好地理解。
详细解释某一步，而代码中没有明确表达。
在代码本身中为用户留下不同的提示。
为娱乐留下注释。
暂时禁用代码的一部分用于调试目的。
为代码添加元数据以备将来使用。
为代码创建文档，例如在 Github 页面中。