小白学Java 第5课：注释

【相关链接】

上一篇：小白学Java 第4课：第一个程序 Helloworld

下一篇：小白学Java 第6课：常量与变量

总纲：返回列表

 

【1】注释是什么？

注释就是对代码的解释说明，并不会参与代码的任何计算，他只是起到一个说明的作用。

以后写代码中，为了思路清晰，写注释是一个很好的习惯。 

注释分为 单行注释 和 多行注释。 

【2】单行注释

打开我们上节课的项目，然后打开文件 HelloWorldTest.java 。

然后我们在输出语句代码上面，打上 两个右斜杠（ 这就是单行注释规则 ），斜杠后面为注释的内容。

细心的同学可能发现我的代码风格已经变了，其实是我设置了字体显示和大小。

详情看这里：Eclipse 设置字体大小和格式

【3】多行注释

（3.1）我们先在类名称上面输入一个 /**

（3.2）然后敲下回车，可以看到这时会自动生成一些注释，这个 @author Qiang 表示这个文件的作者是Qiang（我电脑用户名），Qiang的下面报黄色警告线，不用管他，因为他会认为你这时一个单词，存在拼写错误。

（3.3）当然你也可以对他进行修改，比如我们将作者改为诸葛亮。

另外我们还可以自定义一个时间，先写一个@符号，然后写上时间date的单词，表明这个文件的创建时间。

 

（3.4）除了自定义外，系统其实还有很多系统定义好的。
你写一个@符号，然后别动，可以看到好多提示，这里我不一一说明，有兴趣的自己下去查资料。

（3.5）最重要的我们还没写，那就是对这个文件类的说明，下面加上。

（3.6）常见的多行注释，我们不仅可以打在类上面，而且还可以打在方法（方法后面具体讲）上，如下所示。

（3.7）多行注释除了这种格式，还有一种，你们可以把下面这段代码复制到你文件里，然后保存。

这是这种注释相对来说，用得比较少，大家了解即可。

/*
 * 连续输出1-100 
 */
for (int i = 1; i < 100; i++) {
	System.out.println(i);
}

【4】注释的规范

（1）一般来说，类上面，方法上面用多行注释，具体逻辑实现用单行注释；

（2）注释一般放在代码前面，即注释在你需要解释的代码前面（ 有的时候也可以放在同行后面 ，但绝不能放在代码后面）。

 

【相关链接】

上一篇：小白学Java 第4课：第一个程序 Helloworld

下一篇：小白学Java 第6课：常量与变量

总纲：返回列表