C++ Primer 5th - 1.3 关于注释

当我们的程序变得更加复杂之前，我们应该知道在C++中如何很好的处理注释。注释可以很好的帮助我们阅读代码。注释一般用于对一个算法的总结，声明变量的意图或是标明一段难以读懂的代码。编译器会无视注释，所以注释对程序的行为和效率没有任何影响。

C++里的注释

C++里有两种注释：一种是当行另一种是配对。当行注释由//开始已回车为结束。在//后面的所有代码将会被编译器无视。这种注释可以包括任何文本，包括额外的//。

用/* */注释方法的注释继承自C语言。注释从/*开始到*/结束。这样的注释可以包括除了*/之外的所有文本。编译器会无视注释段里的所有代码。当这种注释包括了多行时，我们经常认为它是个多行注释。

程序里通常会出现这两种风格的注释。注释对的形式通常用于多行注释，当行形式通常用于当行注释。

#include <iostream>
/*
* Simple main function:
Download at http://www.pin5i.com/
C++ Primer, Fifth Edition
* Read two numbers and write their sum
*/
int main()
{
    // prompt user to enter two numbers
    std::cout << "Enter two numbers:" << std::endl;
    int v1 = 0, v2 = 0; // variables to hold the input we read
    std::cin >> v1 >> v2; // read input
    std::cout << "The sum of " << v1 << " and " << v2
    << " is " << v1 + v2 << std::endl;
    return 0;
}

注释对不要嵌套

通常情况下，一个注释对不能出现在另一个注释对的内部。这种情况下，编译器会发出困惑的错误或警告信息。举个例子，在你的系统下编译如下代码：

/*
* comment pairs /* */ cannot nest.
* ''cannot nest'' is considered source code,
* as is the rest of the program
*/
int main()
{
    return 0;
}

我们经常需要在debug时对注释掉一段代码。由于我们想要注释的代码段内部也有注释对，这样就会引起注释嵌套。最好的办法是在每行的开头加上//。如下所示：

// /*
// * everything inside a single-line comment is ignored
// * including nested comment pairs
// */