代码编写规范:
- 要有一定的注释;
- 程序块要采用缩进风格编写,缩进只使用TAB键,不能使用空格键(编辑器中将TAB键设置为4格);
- 方法体的开始、类的定义、以及if、for、do、while、switch、case语句中的代码都要采用缩进方式;
- 程序块的分界符左大括号“{”和右大括号“}”都另起一行,应各独占一行并且位于同一列,同时与引用它们的语句左对齐;
- 对齐只使用TAB键,不使用空格键;
- 一行只写一条语句;
- If、for、do、while、switch、case、default等语句自占一行;
- 一行的长度超过80个字符需要换行,换行在一个逗号后面断开,在一个操作符前面断开;
- 多行注释使用注释界定符“/*...*/”;
- 命名采用大小写混合,提高名字的可读性;采用该领域的术语,尽量少用缩写,但如果一定要用,当使用公共缩写和习惯缩写等;避免使用相似或者仅在大小上有区别的名字;
- 变量命名采用大小写混合的方式,第一个单词的首字母小写,其后单词的首字母大写;变量名不应以下划线或美元符号开头;尽量避免单个字符的变量名,除非是一次性的临时变量。临时变量通常被取名为i,j,k,m和n,它们一般用于整型;c,d,e,它们一般用于字符型;对不易清楚识别出该变量类型的变量应使用类型名或类型名缩写作其后缀,如:
Thread animationThread;
String responseStr;
集合类型变量,例如数组和矢量,应采用复数命名或使用表示该集合的名词做后缀:
Image[] images;
Vector requestQueue;
- 常量命名全部采用大写,单词间用下划线隔开:
Static final int MIN_WIDTH=4;
- 方法名是一个动词,采用大小写混合的方式,第一个单词的首字母小写,其后单词的首字母大写;
- If、for、do、while等语句的执行语句部分无论多少都要加括号“{}”;
- 每当一个case顺着往下执行时(因为没有break语句),通常应在break语句的位置添加注释;
- 尽量避免在循环中构造和释放对象;
- 在使用局部变量的过程,按就近原则处理。不允许定义一个局部变量,然后在很远的地方才使用;
- 相同的功能不允许复制成N份代码;
- 在处理String的时候要尽量使用StringBuffer类。