一、为什么要写注释?
为什么要添加注释?至少有三方面的考虑。
**1.帮你回忆起当时编写的思路。**一段程序编写完成后,思路还很清晰,但是在过了一段时间之后,重看该程序,不一定能快速地回忆/理解当时的思路。此时注释可以有效地则到这一点。
**2.让编写者以外的人快速有效地理解该段代码地作用,提升工作效率。**在日后的工作中,必然存在编程者本人只负责某一部分地代码构建的情况,此时注释便可有效的做到提升团队成员间的沟通效率和工作效率。
**3.代码即文档。**目前的工作中写注释已成为规范中的一点要求,毕竟没人会想要在接手前人的工作时,遇到没有注释全靠自己去理解全部代码的情况,那是会被人在背后骂的。
二、注释的分类
java语言中,注释的分类:
**1.单行注释**
将双斜线(//)放在需要注释的内容之前即可。
public class HelloWorld {
public static void main(String[] args) {
//输出“Hello World”
System.out.println("Hello World!");
}
}
2.多行注释
使用“/*”和“*/”将程序中需要注释的内容包含起来,中间每一行用“*”开头,“/*”表示注释开始,“*/”表示注释结束。
也可在每一行之前加上“//”。
public class HelloWorld {
public static void main(String[] args) {
/*
*这是java的“Hello World”
*输出“Hello World”
*/
System.out.println("Hello World!");
}
}
三、一些注意点
1.不是每一行都需要进行注释,在一小段功能上注释,让人知道该段功能做了什么即可。
2.注释都写在代码的上方。
3.一些代码必须要进行注释,比如抽象方法,除了返回值、参数、异常说明外,还必须指出该方法做什么事情,实现什么功能,其他必须注释的根据各公司的要求而定。
评论
登录后参与技术讨论,分享你的经验与见解。
登录 / 注册暂无评论