博客
关于我
强烈建议你试试无所不能的chatGPT,快点击我
【共读Primer】3.[1.3]注释简介 Page8
阅读量:4993 次
发布时间:2019-06-12

本文共 897 字,大约阅读时间需要 2 分钟。

C++的注释有两种

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

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

 

1 #include 
// 标准库中输入输出流的库名称 2 /* 3 * 简单主函数: 4 * 读取两个数,求它们的和 5 */ 6 int main() 7 { 8 std::cout << "Enter two numbers:" << std::endl;// 输出一个提示信息的字符串,并在结尾换行 9 int v1 = 0, v2=0;// 声明两个int型的变量,都赋值为010 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. 注释的代码一致性也是很重要的,修改代码的同时一定要修改注释,否则宁愿没有注释

 

转载于:https://www.cnblogs.com/ChattyKu/p/9393972.html

你可能感兴趣的文章
如何用自己电脑做服务器,绑定域名建一个个人网站
查看>>
.ds_store是什么文件
查看>>
递归C++
查看>>
POJ 1751 Highways(最小生成树&Prim)题解
查看>>
linux 安装openssh-server, openssh-client
查看>>
Java继承的基本概念及其限制 总结
查看>>
RF1001: 各浏览器对 '@font-face' 规则支持的字体格式不同,IE 支持 EOT 字体,Firefox Safari Opera 支持 TrueType 等字体...
查看>>
Socket 学习(三)
查看>>
题解 CF43B 【Letter】
查看>>
CommandName and CommandArgument
查看>>
[z]FNV哈希算法
查看>>
通过层序和中序遍历序列重建二叉树
查看>>
【Git】git clone与git pull区别
查看>>
【SVN】SVN的trunk、branches、tag的使用以及分支的概念
查看>>
JS闭包理解
查看>>
整数对题目
查看>>
php设计模式-观察者模式
查看>>
NFC技术:使用Android Beam技术传输文本(一)
查看>>
C++判断一个文件是否可以正确打开的代码
查看>>
unity 判断 是手机还是平板
查看>>