【自学C++】C++注释

桃扇骨 2024-03-30 15:43 58阅读 0赞

## C++注释 ##

### C++注释教程 ###

用于注解说明解释程序的文字就是注释，注释提高了代码的阅读性。同时，注释也是一个程序员必须要具有的良好编程习惯。我们应该首先将自己的思想通过注释先整理出来，再用代码去体现。

在 **C++** 中，一旦程序中某部分内容被注释掉，则该内容将会被 C++ 解释器忽略，换句话说，此部分内容将不会被执行。

### C++注释作用 ###

注释不仅可以用来解释程序某些部分的作用和功能（用自然语言描述代码的功能），在必要时，还可以将代码临时移除，是调试程序的好帮手。

通常而言，合理的代码注释应该占源代码的 1/3 左右。

### C++注释形式 ###

C++ 提供了两种注释的形式行注释和块注释。

#### 行注释 ####

// 注释内容

#### 说明 ####

C++ 的行注释使用的是 `//`，将需要被注释的内容放在 `//` 后面即可。

#### 块注释(多行注释) ####

/* 
    * 注释内容
    */

#### 说明 ####

C++ 的块注释使用的 `/**/`，C++ 块注释就是可以一次注释多行代码，但块注释不可以嵌套使用。

### 案例 ###

#### C++行注释 ####

C++ 行注释只能用来注释单行代码

#include <iostream>
    using namespace std;
    
    int main(int argc, char **argv)
    {
    	//cout << "Hello 嗨客网(www.haicoder.net)" << endl;
    	
    	cout << "嗨客网(www.haicoder.net)" << endl;
        cout << "Hello HaiCoder" << endl;
        
    	//cout << "嗨客网" << endl; 这是行注释，这里不会被执行
    }

程序运行，控制台输出，如下图：

![请添加图片描述][05356ed39ebd42658168dd7f1c7b5bc8.png]

我们可以看到，我们的程序并没有输出第一句和最后一句，因为，这两句都被我们注释了，被注释的代码不会被执行。

#### C++块注释 ####

C++ 块注释也可以用来注释单行代码

#include <iostream>
    using namespace std;
    
    int main(int argc, char **argv)
    {
    	/* cout << "www.haicoder.net" << endl; */
    	
    	cout << "嗨客网(www.haicoder.net)" << endl;
        cout << "Hello HaiCoder,Hello Mul Comment" << endl;
        
    	/* cout << "嗨客网" << endl; 这是注释，这里不会被执行 */
    }

程序运行，控制台输出，如下图：

![请添加图片描述][e8cfe357af5e44cd80e15f6a9bede210.png]

我们可以看到，我们使用了 C++ 的多行注释也就是块注释，注释了单行代码。

#### C++块注释 ####

C++ 块注释可以用来一次注释多行代码

#include <iostream>
    using namespace std;
    
    int main(int argc, char **argv)
    {
    	/* 
    		cout << "www.haicoder.net" << endl; 
    		cout << "嗨客网" << endl;
    	*/
    	
    	cout << "嗨客网(www.haicoder.net)" << endl;
        cout << "Hello HaiCoder,Hello Mul Comment" << endl;
    }

程序运行，控制台输出，如下图：

![请添加图片描述][3f6a71fc464f44f7867ac95912ec079c.png]

我们使用了块注释，一次性注释了两行代码。

#### C++块注释 ####

C++ 块注释不可以嵌套

#include <iostream>
    using namespace std;
    
    int main(int argc, char **argv)
    {
    	/* 
    		cout << "www.haicoder.net" << endl; 
    		cout << "嗨客网" << endl;
    		
    		/*这里是嵌套注释*/
    	*/
    	
    	cout << "嗨客网(www.haicoder.net)" << endl;
        cout << "Hello HaiCoder,Hello Mul Comment" << endl;
    }

程序运行，控制台输出，如下图：

![请添加图片描述][cfcf60c7736f432c81ec50eea8dcd30a.png]

我们可以看到，运行时直接报错，因为块注释是不支持嵌套的。

### C++注释总结 ###

C++ 注释分为单行注释和块注释，其中单行注释可以嵌套，块注释不可以嵌套。

[05356ed39ebd42658168dd7f1c7b5bc8.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/30/1280c02858da4ab2886bed514305f540.png
[e8cfe357af5e44cd80e15f6a9bede210.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/30/f20328b1386c4382b67523145f3a9a88.png
[3f6a71fc464f44f7867ac95912ec079c.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/30/666f4ce35431404eadf085de12f3c15a.png
[cfcf60c7736f432c81ec50eea8dcd30a.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/30/1de4fcfbec6c438787593b226810d1cd.png