编码规范

编码规范对于程序开发人员很重要,遵循编码规范所编写的程序代码可读性高,有维护价值,如果你编写的程序代码别人看不懂、甚至没有人愿意看,那么你所编写的程序代码就一文不值,而且这样的程序,再过一段时间连开发者自己也会忘记程序的业务逻辑,无法有效地维护程序代码。

在学习开发的过程中一定要养成良好的编码规范,对于规整的代码格式会给程序的开发与日后的维护提供很大方便。这里将程序的编码规则做了简单总结,供大家学习。

l        每条语句要单独占一行,一条命令要以分号结束。

注意:在程序代码中的分号必须为英文状态下,初学者经常会将“;”写成中文状态下的“;”,此时编译器会报出“illegal character(非法字符)这样的错误信息。

l        在声明变量时,尽量使每个变量的声明单独占一行,即使是相同的数据类型也要将其放置在单独的一行上。这样有助于添加注释。对于局部变量应在声明的同时对其进行初始化。

l        Java代码中,关键字与关键字间如果有多个空格,这些空格均被视作一个。例如:

而多于的空格没有任何意义,为了便于理解、阅读,应控制好空格的数量。

l        变量的命名要尽量使用有意义的名称,最好采用英文描述符。另外,变量的第一个单词小写,第二个以后的单词要求首字母大写。例如,productPriceagenameuserName

l        类名和接口的命名不但要求使用有意义的单词而且所有单词的首字母都要大写,例如:ProductFactoryUserInfo

l        常量的所有字母均为大写,多个单词使用“_”下划线分割。例如,PRODUCT_UNIT

l        适当的缩进代码,使代码对齐。但也不要添加过多的缩进,以至于代码被缩进出很远,这样同样能导致代码的可读性下降。

l        合理的使用空白行,这样可以将逻辑相关的代码分隔开,以提高可读性。

l        为了方便日后的维护,不要使用技术性很高、难懂、易混淆判断的语句。通常情况下,由于程序的开发与维护不能是同一个人,所以应尽量使用简单的技术完成程序需要的功能。

l         对于关键的方法要多加注释,这样有助于阅读者很快地了解代码结构。

l         遵循工程规定的统一代码格式,一般情况下,直接使用IDE自带的默认代码格式对代码进行格式化。,例如,在Eclipse中,可以使用〈Ctrl+Shift+F〉快捷键,自动格式化程序代码。