《C++入门经典(第6版)》——2.3 注释

简介:

本节书摘来自异步社区出版社《C++入门经典(第6版)》一书中的第2章,第2.3节,作者: 【美】Rogers Cadenhead(罗格斯 卡登海德) , Jesse Liberty(杰西 立波提) ,更多章节内容可以访问云栖社区“异步社区”公众号查看。

2.3 注释

在您编写程序时,每行源代码的功能显而易见,但随着时间的流逝,再回过头来修复程序Bug或添加新功能时,可能发现对自己以前做的工作感到一头雾水。

为了避免这种困境,并帮助他人理解您编写的程序,可在源代码中添加注释。注释是阐述程序做什么的文本,编译器对其置之不理,因此只能给阅读代码的人带来好处。

在C++中,有两种类型的注释。单行注释以两个斜杠(//)打头,导致编译器忽略从这里开始到行尾的全部内容,下面是一个例子:

// The next line is a kludge (ugh!)
多行注释以斜杠和星号(/)打头,并以星号和斜杠(/)结尾。/和/之间的所有内容都是注释,哪怕它们占据多行。如果程序中不存在与/配套的/,编译器将视之为错误。下面是一个多行注释:

/* This part of the program doesn't work very well. Please remember to
   fix this before the code goes live –– or else find a scapegoat you can
   blame for the problem. The new guy Curtis would be a good choice. */

在上述注释中,为了提高可读性而将文本左对齐,但并非必须这样,因为编译器忽略/和/之间的所有内容。在这里,可包含任何内容:杂货清单、情诗、从未告诉过别人的秘密等。

watch 

警告:关于多行注释,需要牢记的一个重点是,不能将其嵌套。如果您使用/开始注释,并在几行后又使用了一个/,则编译器见到第一个/后,将认为多行注释到此结束,这样第二个/将导致编译器错误。大多数C++编辑器都以不同的颜色显示注释,让注释的开始和结束位置非常清晰。
在稍后您将创建的项目中,包含了这两种类型的注释。请在程序中添加大量注释,您为解释代码的功能而在编写注释上花的时间越多,几周、几月甚至几年后,代码就越容易理解。

相关文章
【期末不挂科-C++考前速过系列P6】大二C++实验作业-模板(4道代码题)【解析,注释】
【期末不挂科-C++考前速过系列P6】大二C++实验作业-模板(4道代码题)【解析,注释】
【期末不挂科-C++考前速过系列P6】大二C++实验作业-模板(4道代码题)【解析,注释】
|
C++ 编译器
C++中的注释作用
C++ 代码中的注释可提高可读性,有单行和多行两种形式。单行注释以 `//` 开始,多行注释用 `/* ... */` 包裹。`#if 0 ... #endif` 用于条件编译,可实现可屏蔽的代码块,常用于调试。`#if` 后可跟条件表达式,在满足条件时执行相应代码。
216 4
|
算法 编译器 C++
C++注释
C++注释
211 2
|
Serverless C++ 容器
【期末不挂科-C++考前速过系列P5】大二C++实验作业-多态性(3道代码题)【解析,注释】
【期末不挂科-C++考前速过系列P5】大二C++实验作业-多态性(3道代码题)【解析,注释】
|
C++ 芯片
【期末不挂科-C++考前速过系列P4】大二C++实验作业-继承和派生(3道代码题)【解析,注释】
【期末不挂科-C++考前速过系列P4】大二C++实验作业-继承和派生(3道代码题)【解析,注释】
|
编译器 C++
【期末不挂科-C++考前速过系列P3】大二C++第3次过程考核(20道选择题&12道判断题&2道代码题)【解析,注释】
【期末不挂科-C++考前速过系列P3】大二C++第3次过程考核(20道选择题&12道判断题&2道代码题)【解析,注释】
【期末不挂科-C++考前速过系列P2】大二C++第2次过程考核(20道选择题&10道判断题&3道代码题)【解析,注释】
【期末不挂科-C++考前速过系列P2】大二C++第2次过程考核(20道选择题&10道判断题&3道代码题)【解析,注释】
|
编译器 C++
C++中的注释作用
C++ 中的注释用于提高代码可读性,有单行和多行两种形式。单行注释以 `//` 开始,多行注释用 `/* ... */` 包裹。`#if 0 ... #endif` 用于条件编译,可实现代码的临时屏蔽,适用于调试和测试。
119 0
|
Linux Shell 开发工具
C++ 的 ini 配置文件读写/注释库 inicpp 用法 [ header-file-only ]
这是一个C++库,名为inicpp,用于读写带有注释的INI配置文件,仅包含一个hpp头文件,无需编译,支持C++11及以上版本。该库提供简单的接口,使得操作INI文件变得容易。用户可通过`git clone`从GitHub或Gitee获取库,并通过包含`inicpp.hpp`来使用`inicpp::iniReader`类。示例代码展示了读取、写入配置项以及添加注释的功能,还提供了转换为字符串、双精度和整型的函数。项目遵循MIT许可证,示例代码可在Linux环境下编译运行。
1417 0
|
存储 数据安全/隐私保护 C++
【期末不挂科-C++考前速过系列P1】大二C++第1次过程考核(3道简述题&7道代码题)【解析,注释】
【期末不挂科-C++考前速过系列P1】大二C++第1次过程考核(3道简述题&7道代码题)【解析,注释】