1. 什么是注释
1) 注释是在所有计算机语言中都非常重要的一个概念,从字面上看,就是注解、解释的意思
2) 注释可以用来解释某一段程序或者某一行代码是什么意思,方便程序员之间的交流。假如我写完一行代码后,加上相应的注释,那么别人看到这个注释就知道我的这行代码是做什么用的
3) 注释可以是任何文字,也就是说可以写中文
4) 在开发工具中注释一般是豆沙绿色
2. 单行注释
1) 单行注释以两个正斜杠开头,也就是以//开头,只能注释一行,从//开始到这行的结尾都是注释的内容
2) 任何地方都可以写注释:函数外面、里面,每一条语句后面
3. 多行注释
多行注释以/*开头,以*/结尾, /*和*/中间的内容都是注释
4. 注释的作用
1> 被注释的代码不会参与编译
*注释是写给人看的,不是给计算机看的。计算机怎么可能看得我们写的中文嘛。因此,当编译程序的时候,并不会将注释编译到.o目标文件中
*从.o文件的大小可以间接看出注释后的代码并没有被编译
2> 检查代码的作用
3> 排除错误
5. 注释的嵌套现象
1) 单行注释可以嵌套单行注释、多行注释
// 单行1 // 单行2
// /* dssf */ // dssfblog
2) 多行注释可以嵌套单行注释
/*
// 这是一个注释
// 这还是一个注释
这全部是注释
*/
3) 多行注释不能嵌套多行注释
/* 12345
/*上山打老虎*/
老虎不在家 */
4) 下面的写法是错误的
// /*
这边没被注释,应为/*被//给注释掉了
*/
6. 注释的重要性
l、要养成写注释的良好习惯。绝大部分项目经理检查下属代码的第一件事就是看有没有写注释,也有很多公司的机试也会检查注释(机试就是给你一道编程题、一台电脑,在规定时间内解题)
2、今天,你写了几百行代码,很高兴,做出了一个非常不错的功能,但是,忘了写注释。一个星期过后,你再回去看那一段代码,你可能完全看不懂了,这是很正常的事。如果你写了注释,那情况就不一样了,注释可以帮助你回顾代码的作用。
3、你在某家公司待了1年多,写了10几万行代码,但是你不写一点注释。有一天你离职了,新的员工接手你做的项目,他首先要做的事情肯定是要读懂你写 的代码。可是你一点注释都没写,10万行代码,全部都是英文,这会让这位新员工非常地蛋疼。每个人都有自己的思想,写代码的思路肯定是不一样的,看别人写 的代码是件非常痛苦的事情,特别是没有注释的代码。你不写注释的做法会大大降低公司的开发效率。因此,所有的正规公司都非常重视注释。
时间: 2024-10-22 20:26:52