Java编程那些事儿20—空白、语句结束和注释

Java编程那些事儿20—空白、语句结束和注释

郑州游戏学院 陈跃峰

出自：http://blog.csdn.net/mailbomb

3.8 空白

在前面的内容中，已经介绍了在编写代码中，单词和单词之间需要使用空格进行间隔，至于空格的数量则不限制。

而实际的编码中，为了使代码的结构清晰，一般需要在代码的前面加入一定数量的空格，例如如下格式：

public class Blank{

public static void main(String[] args){

int n;

{

n = 10;

}

System.out.println(n);

}

}

在该代码中，除了第一行和最后一行外，每行都包含一定数量的空格，这种编码的格式称为代码缩进。

在实际代码中，只要存在包含关系，则代码就应该缩进，语句块是最典型的包含关系之一。说明：在编译时，每行开始的空格都会被忽略掉。

3.9 语句结束

Java语法中，语句以“;”作为行结束符，例如：

int n = 2;

通常情况下，代码中每行只写一句代码，但是也可以写多句，例如：

int n = 2; byte b = 10;

但是一般为了代码结构清楚，只在一行中书写一句代码。

有些时候代码本身比较长，则也可以把一句代码写在多行，而代码语句结束的地方书写一个“;”即可。

在实际代码中，一般大括号开始和结束的地方，以及大部分小括号结束的地方都不需要书写“;”来进行结束。

3.10 注释

注释(comment)是对代码功能和用途的说明。在程序中编写适当的注释，将使程序代码更容易阅读，增强代码的可维护性。

注释在程序编译时都会被忽略，所以注释不会增加class文件的大小。

Java语言中注释的语法有三种：单行注释、多行注释和文档注释。

3.10.1 单行注释

单行注释指只能书写一行的注释。单行注释属于注释中最简单的语法格式，用于对于代码进行简单的说明，例如变量功能等。

单行注释的语法格式为：

//注释内容

注释以两个斜线开始，该行后续的内容都是注释的内容，注释内容不能换行。

单行注释一般书写在需要说明的代码的上一行，或者该行代码的结束处，示例结构如下：

//循环变量

int i = 0;

char sex;//性别

3.10.2 多行注释

多行注释指可以书写任意多行的注释。多行注释一般用于说明比较复杂的内容，例如程序逻辑或算法实现原理等。

多行注释的语法格式为：

/*

注释内容

*/

注释以一个斜线和一个星号开始，后续是注释内容，注释内容可以书写任意多行，最后注释以一个星号和一个斜线结尾。

很多多行注释在每行以星号开始，这个不是语法必需的。

3.10.3 文档注释

文档注释指可以被提取出来形成程序文档的注释格式，这是Java语言有特色的注释格式。一般对于程序程序的结构进行说明，例如类、属性、方法和构造方法进行说明，这些概念在后续将详细介绍。

文档注释的语法格式为：

/**

注释内容

*/

注释以一个斜线和两个星号开始，后续是注释内容，注释内容可以书写任意多行，最后注释以一个星号和一个斜线结尾。

在后续内容中还将完善该注释的语法格式。

3.10.4 其它

在规范的代码中，一般有10%-20%的注释，也就是每100行代码中包含10-20行注释的内容，但是国内很多开发公司都远远达不到这个要求。

另外需要特别注意的是，在实际的项目开发中，在修改代码后，一定要对应的修改注释的内容，保持代码和注释内容的同步。