HOME/CPP Primer/

1.3 注释简介

Article Outline
TOC
Collection Outline

1.3 注释简介

C++中注释的种类

C++中有两种注释:单行注释和界定符对注释。单行注释以双斜线(//)开始,以换行符结束。当前行双斜线右侧的所有内容都会被编译器忽略,这种注释可以包含任何文本,包括额外的双斜线。

另一种注释使用继承自C语言的两个界定符(//)。这种注释以/开始,以/结束,可以包含除/外的任意内容,包括换行符。编译器将落在/和*/之间的所有内容 都当作注释。

注释界定符可以放置于任何允许放置制表符、空格符或换行符的地方。注释界定符可以跨越程序中的多行,但这并不是必须的。当注释界定符跨越多行时,最好能显式指出其 内部的程序行都属于多行注释的一部分。我们所采用的风格是,注释内的每行都以一个星号开头,从而指出整个范围都是多行注释的一部分。

程序中通常同时包含两种形式的注释。注释界定符对通常用于多行解释,而双斜线注释常用于半行和单行附注。

#include <iostream>
/*
 * 简单主函数:
 * 读取两个数,求它们的和
 */
int main()
{
    // 提示用户输入两个数
    std::cout << "Enter two numbers:" << std::endl;
    int v1 = 0,v2 = 0;      // 保存我们读入的输入数据的变量
    std::cin >> v1 >> v2;   // 读取输入数据
    std::cout << "The sum of " << v1 << " and " << v2 << " is " << v1 + v2 <<std::endl;
    return 0;
}

注释界定符不能嵌套

界定符对形式的注释是以/开始,以/结束的。因此,一个注释不能嵌套在另一个注释之内。编译器对这类问题所给出的错误信息可能是难以理解、令人迷惑的。

我们通常需要在调试期间注释掉一些代码。由于这些代码可能包含界定符对形式的注释,因此可能导致注释嵌套错误,因此最好的方式是用单行注释方式注释掉代码段的每一行。

// /*
// *单行注释中的任何内容都会被忽略
// *包括嵌套的注释对也一样会被忽略
// */