【共读Primer】3.<1.3>注释简介 P…

2018-08-02 05:43:47来源:博客园 阅读 ()

新老客户大回馈,云服务器低至5折

C++的注释有两种

1.  双斜杠开始到本行结束 (//)

2. 斜杠星开始 星斜杠结束 (/*)(*/)

 

 1 #include <iostream> // 标准库中输入输出流的库名称
 2 /*
 3  * 简单主函数:
 4  * 读取两个数,求它们的和
 5  */
 6 int main()
 7 {
 8     std::cout << "Enter two numbers:" << std::endl;// 输出一个提示信息的字符串,并在结尾换行
 9     int v1 = 0, v2=0;// 声明两个int型的变量,都赋值为0
10     std::cin >> v1 >> v2;// 从键盘输入中读取两个数字,分别写入v1和v2两个变量中
11     std::cout << "The sum of " << v1 << " and " << v2// 与下一行是一条命令
12                    << " is " << v1 + v2 << std::endl;// 输出v1、v2的值,并且输出两数之和的值
13     return 0;
14 }

我们把上次的代码加上一个比较详细的注释。

注释的目的: 让代码阅读者更清晰的理解编码者的代码意义。

注释的一种错误用法   ,/* */的嵌套使用

/*
 * 注释对 /* */ 不能嵌套。
 * “不能嵌套” 几个字会被认为是源码,
 * 象剩余程序一样处理
 */
int main()
{
   return 0  
}

大家看一下代码着色就能发现,嵌套使用后的注释对会出现问题。

从以往的编码经验中得到关于注释的经验有以下几点

1. 注释并不是越多越好,能很好自解释的代码就没有必要写注释,而对于复杂的算法或逻辑关系应该写清楚

2. 注释最重要的一点是给别人,或者以后的自己看,所以要保证读者能够在尽量短的时间内理解

3. 注释的代码一致性也是很重要的,修改代码的同时一定要修改注释,否则宁愿没有注释

 

标签:

版权申明:本站文章部分自网络,如有侵权,请联系:west999com@outlook.com
特别注意:本站所有转载文章言论不代表本站观点,本站所提供的摄影照片,插画,设计作品,如需使用,请与原作者联系,版权归原作者所有

上一篇:【共读Primer】5. 篇外篇----关于Sales_item

下一篇:洛谷P3773 [CTSC2017]吉夫特(Lucas定理,dp)