Java源程序的可读性的要求:程序符合编程规范,程序清晰、可读

一、注释:

1.行注释://注释内容(用的最多的)
2.块注释:/*注释内容*/(不推荐)
3.文档注释:  javadoc标记
/**文档注释*/(常用于方法和类之上描述方法和类的作用),可用来自动生成文档

二、标识符的命名规范

1.符合语法
2.有意义,见名知义
3.简洁

4.符合Java的命名规范(有两种命名方式)

camel命名方式:用于方法名,普通变量名称。
若标识符是由单个单词组成,则全小写int age = 5;
若标识符是由多个单词组成,除了第一个单词全小写以外,第二个单词以及之后的单词首字母大写。 int myAge = 10;

Pascal命名方式:用于类、接口命名
类名是以大写字母开头的单词;

若类名由多个单词组成,则每个单词首字母大写
class Test
class MyTest

1)类名:Pascal命名方式
2)变量名(局部变量、形参、实例域、静态域):camel命名方式
3)方法名:camel命名方式
4)包名:全部小写
5)常量:单词全大写,多个单词间以_分隔 final int MY_AGE = 10;
6)java主类名必须与源文件名保持一致

三、缩进

有两种选择:

A.      K&R风格
这是C程序最早的缩进风格,由C的发明者Ritchie和他的合作者Kernighan率先使用:
if (<cond>) {
    <body>
}
其特点,是大括号和if判断在同一行。通常,缩进为8个空格或一个tab键,但在C++和Java里,也常缩进4个空格。有人喜欢用两个空格,窃以为不好,不明显。

 

B.      BSD 风格
又称Allman Style,源自Unix BSD程序员Eric Allman--他为BSD写过很多程序:
if (<cond>)
{
    <body>
}
特点:大括号和条件判断分在两行。

那么在Java里用哪种好呢?建议采用A或B。

SUN有一个Java Code Name Convention,建议的是A。
 

四、Tab还是空格(Tabs vs Space)

在缩进的时候,尽量不用Tab,而是用空格。

好在许多编辑器,都可以把你的键盘上的Tab键定义成几个空格。赶紧去定义它!
每次用多少空格呢? 4个。2个太少不明显,8个太多占空间。