《疯狂Java讲义(第3版)》.(李刚)——java命名规则及编码规范

迷南。 2022-08-21 05:56 24阅读 0赞

**1、命名规则：**

此处借鉴一下他人的资料，比较全面一些，方便了解学习。

1.  JAVA源文件的命名　　JAVA源文件名必须和源文件中所定义的类的类名相同。
2.  Package的命名　　Package名的第一部分应是小写ASCII字符，并且是顶级域名之一，通常是com、edu、gov、mil、net、org或由ISO标准3166、1981定义的国家唯一标志码。Package名的后续部分由各组织内部命名规则决定，内部命名规则指定了各组件的目录名，所属部门名、项目名等。
3.  Class/Interface的命名　　Class名应是首字母大写的名词。命名时应该使其简洁而又具有描述性。异常类的命名，应以Exception结尾。Interface的命名规则与Class相同。
4.  常量的命名　　常量名的字母应全部大写，不同的单词之间通过下划线进行连接，并且名字组合应该赋予含义。
5.  变量的命名  
    5.1 普通变量　　普通变量名的首字母小写，其它每个单词的首字母大写。命名时应该使其简短而又有特定含义，简洁明了的向使用者展示其使用意图。  
    5.2 约定变量　　所谓约定变量，是指那些使用后即可抛弃（throwaway）的临时变量。通常i、j、k、m和n代表整型变量；c、d和e代表字符型变量。
6.  方法的命名　　方法名的第一个单词应是动词，并且首字母小写，其它每个单词首字母大写。
7.  方法参数的命名　　应该选择有意义的名称作为方法的参数名。如果可能的话，选择和需要赋值的字段一样的名字。

**2、补充资料：**

1、类名首字母应该大写。属性（成员变量）、方法、对象变量以及所有标识符（如形式参数、实际参数、局部变量）的首字母应小写，其中包含的所有单词都应紧靠在一起，而且大写中间单词的首字母。例如：  
类名：ThisIsAClassName 属性或方法名：thisIsMethodOrFieldName对象变量：thisIsAClassVariable

2、Java 包（Package）属于一种特殊情况，它们全都是小写字母，即便中间的单词亦是如此。对于全局包，将你的Internet 域名反转并接上包名。例如：  
cn.edu.usst.dingyuewei.package。  
另外，package 行要在import 行之前，import 中标准的包名要在本地的包名之前，而且按照字母顺序排列。如果import 行中包含了同一个包中的不同子目录，则应该用 \* 来处理。例如：

package hotlava.net.stats; 
    import java.io.*; 
    import java.util.Observable; 
    import hotlava.util.Application;

这里 java.io.\* 是用来代替InputStream and OutputStream 的。

3、接口（Interface）：采用完整的英文描述符说明接口封装，所有单词的第一个字母大写。习惯上，名字后面加上后缀 able， ible 或者 er。例如：Contactable，Prompter。

4、组件（Component）使用完整的英文描述来说明组件的用途，末端应接上组件类型。例如：okButton，customerList，fileMenu。

5、类中常用方法的命名：

a)类的获取方法（一般具有返回值）一般要求被方法名使用被访问字段名，前面加上前缀get，例如getFirstName(), getLastName()。

b)类的布尔型的判断方法一般要求方法名使用单词 is 做前缀，如isPersistent(),isString()。或者使用具有逻辑意义的单词，例如equal 或equals

c)类的设置方法（一般返回类型为void）：被访问字段名的前面加上前缀 set，例如setFirstName(),setLastName()，setWarpSpeed()

d)类的普通方法一般采用完整的英文描述说明成员方法功能，第一个单词尽可能采用一个生动的动词，第一个字母小写，例如 openFile(), addAccount()。

e)构造方法应该用递增的方式写（比如：参数多的写在后面）。例如：  
public CounterSet()\{\}  
public CounterSet(int size)\{ this.size = size;\}

f)toString 方法：一般情况下，每一个类都应该定义toString 方法，其格式为：public String toString() \{…\}

g)一般应考虑置入一个main()方法，其中包含用于测试那个类的代码，如果包含了main() 方法, 那么它应该写在类的底部。

6、静态常量字段（static final）一般全部采用大写字母，单词之间用下划线分隔（也有特例，如Java 类库中关于颜色的常数没有严格地全部使用大写字母）。例如MIN\_BALANCE,DEFAULT\_DATE。

7、循环计数变量通常采用字母 i，j，k 或者 counter。而数组应该总是用下面的方式来命名：objectType\[\]或 byte\[\] buffer。

**3、编码规范**

1、缩进  
缩进建议以4个空格为单位。建议在 Tools/Editor Options 中设置 Editor 页面的Block ident为4，Tab Size 为8。预处理语句、全局数据、标题、附加说明、函数说明、标号等均顶格书写。语句块的”\{“、”\}”配对对齐，并与其前一行对齐，语句块类的语句缩进建议每个”\{“、”\}”单独占一行，便于匹对。JBuilder 中的默认方式是开始的”\{“不是单独一行，建议更改成上述格式（在 Project/Default Project Properties 中设置 Code Style 中选择 Braces 为 Next line）。  
2、空格  
原则上变量、类、常量数据和函数在其类型，修饰名称之间适当空格并据情况对齐。关键字原则上空一格，如：if ( … ) 等。运算符的空格规定如下：”::”、”->”、”\[“、”\]”、”++”、”–”、”~”、”!”、”+”、”-“（指正负号）、”&”（引用）等几个运算符两边不加空格（其中单目运算符系指与操作数相连的一边），其它运算符（包括大多数二目运算符和三目运算符”?:”两边均加一空格，在作函数定义时还可据情况多空或不空格来对齐，但在函数实现时可以不用。”,”运算符只在其后空一格，需对齐时也可不空或多空格。不论是否有括号，对语句行后加的注释应用适当空格与语句隔开并尽可能对齐。个人认为此项可以依照个人习惯决定遵循与否。  
3、对齐  
原则上关系密切的行应对齐，对齐包括类型、修饰、名称、参数等各部分对齐。另每一行的长度不应超过屏幕太多，必要时适当换行，换行时尽可能在”,”处或运算符处，换行后最好以运算符打头，并且以下各行均以该语句首行缩进，但该语句仍以首行的缩进为准，即如其下一行为“\{”应与首行对齐。  
变量定义最好通过添加空格形成对齐，同一类型的变量最好放在一起。如下例所示：  
int Value;  
int Result;  
int Length;  
Object currentEntry;  
个人认为此项可以依照个人习惯决定遵循与否。  
4、空行  
不得存在无规则的空行，比如说连续十个空行。程序文件结构各部分之间空两行，若不必要也可只空一行，各函数实现之间一般空两行，由于每个函数还要有函数说明注释，故通常只需空一行或不空，但对于没有函数说明的情况至少应再空一行。对自己写的函数，建议也加上“//——”做分隔。函数内部数据与代码之间应空至少一行，代码中适当处应以空行空开，建议在代码中出现变量声明时，在其前空一行。类中四个“p”之间至少空一行，在其中的数据与函数之间也应空行。  
5、注释  
注释是软件可读性的具体体现。程序注释量一般占程序编码量的20%，软件工程要求不少于20%。程序注释不能用抽象的语言，类似于”处理”、”循环”这样的计算机抽象语言，要精确表达出程序的处理说明。例如：”计算净需求”、”计算第一道工序的加工工时”等。避免每行程序都使用注释，可以在一段程序的前面加一段注释，具有明确的处理逻辑。  
注释必不可少，但也不应过多，不要被动的为写注释而写注释。以下是四种必要的注释：  
A. 标题、附加说明。  
B. 函数、类等的说明。对几乎每个函数都应有适当的说明，通常加在函数实现之前，在没有函数实现部分的情况下则加在函数原型前，其内容主要是函数的功能、目的、算法等说明，参数说明、返回值说明等，必要时还要有一些如特别的软硬件要求等说明。公用函数、公用类的声明必须由注解说明其使用方法和设计思路，当然选择恰当的命名格式能够帮助你把事情解释得更清楚。  
C. 在代码不明晰或不可移植处必须有一定的说明。  
D. 及少量的其它注释，如自定义变量的注释、代码书写时间等。  
注释有块注释和行注释两种，分别是指：”/\*\*/”和”//”建议对A用块注释，D用行注释，B、C则视情况而定，但应统一，至少在一个单元中B类注释形式应统一。具体对不同文件、结构的注释会在后面详细说明。  
6、代码长度  
对于每一个函数建议尽可能控制其代码长度为53行左右，超过53行的代码要重新考虑将其拆分为两个或两个以上的函数。函数拆分规则应该一不破坏原有算法为基础，同时拆分出来的部分应该是可以重复利用的。对于在多个模块或者窗体中都要用到的重复性代码，完全可以将起独立成为一个具备公用性质的函数，放置于一个公用模块中。  
7、页宽  
页宽应该设置为80字符。源代码一般不会超过这个宽度, 并导致无法完整显示, 但这一设置也可以灵活调整. 在任何情况下, 超长的语句应该在一个逗号或者一个操作符后折行. 一条语句折行后, 应该比原来的语句再缩进2个字符.  
8、行数  
一般的集成编程环境下，每屏大概只能显示不超过50行的程序，所以这个函数大概要5-6屏显示，在某些环境下要8屏左右才能显示完。这样一来，无论是读程序还是修改程序，都会有困难。因此建议把完成比较独立功能的程序块抽出，单独成为一个函数。把完成相同或相近功能的程序块抽出，独立为一个子函数。可以发现，越是上层的函数越简单，就是调用几个子函数，越是底层的函数完成的越是具体的工作。这是好程序的一个标志。这样，我们就可以在较上层函数里容易控制整个程序的逻辑，而在底层的函数里专注于某方面的功能的实现了。