程序编码规范java.doc

程序编码规范

编写:×××
审核:×××
××××年××月修改
目录
一、引言 3
二、命名规范 3
包(Package)的命名 3
Class的命名 4
Class 变量的命名 4
接口的命名 5
参数的命名 5
数组的命名 5
方法的参数 6
三注释规范 6
块注释(ments) 7
单行注释(Single-ments) 7
尾端注释(ments) 7
行末注释(End-Of-ments) 8
四 Java 文件样式 8
版权信息 8
Package/Imports 9
Class 9
Class Fields 10
存取方法 10
构造函数 10
main 方法 11
换行(Wrapping Lines) 11
行长度(Line Length) 13
语句(Statements) 13
五排版格式 18
六 JSP 编码规范 19
七、文件与目录 20
八、日志规范 20
九、设计及技巧建议 21
22
22
22

一、引言
编码规范对于程序员而言尤为重要,有以下几个原因:
一个软件的生命周期中,80%的花费在于维护。
几乎没有任何一个软件,在其整个生命周期中,均由最初的开发人员来维护。
编码规范可以改善软件的可读性,可以让程序员尽快而彻底地理解新的代码。
如果你将源码作为产品发布,就需要确任它是否被很好的打包并且清晰无误,一如已构建的其它任何产品
为了执行规范,每个软件开发人员必须一致遵守编码规范中的代码规范,代码规范提高软件代码的可读性, 使得开发人员快速和彻底的理解新代码.。好的代码风格不仅会提高可读性,而且会使代码更健壮,更为重要的是在修改时不容易出错。现代软件开发中,维护工作会占用80%的时间,而且开发者和维护者通常不是同一个程序员。这意味着程序员经常要阅读和修改别人开发的程序,别人也同样可能需要阅读和修改你开发的程序,所以制定一套完善的编码规范非常重要。
定义本规范的目的是使项目中所有的文档及程序编码在写作风格上具有一致性,增加可读性,减少项目组中因为换人带来的损失,从而使程序具有良好的可读性。
二、命名规范
包(Package)的命名
包(Packages): 一个唯一包名的前缀应全部为小写的ASCII字母,并且是一个顶级域名,、edu、gov、、org等。包名的后续部分可根据各个不同机构内部的命名规范来定义,这类命名规范可以由特定的目录名来区分部门(department)、项目(project)、机器(machine)和注册名(login names)。
.
.
.
.
.
.xxxxxx .finance
.
如果在开发过程中还有其他情况没有涵盖到,可以按照上述规则进行扩展。
Class的命名
Class的名字必须由一个大写字母开头其他字母为小写的单词构成。类名要用完整的单词,避免使用缩写词(除非该缩写词被更广泛使用,像URL,HTML)。
ActionForm类的命名:以有意义的拼音缩写开头后加ActionForm
Action类的命名:以有意义的拼音缩写开头后加Action
Class 变量的命名
变量名应选用易于记忆、简短富于描述并能够指出其用途的单词。单词不应以下划线或美元符号开头,除一次性临时变量外尽量避免单个字符的变量名。除了变量名外,所有实例,包括类、类常量均采用大小写混合的方式,第一个单词的首字母小写,其后单词的首字母大写。
char c (c、d、e常用于表示字符型)
int I (i、j、k、m、n 常用于表示整型)
float myWidth;
实例变量(Instance Variables)
大小写规则和变量名相似,但前面需要一个下划线 int _employeeId;
String _name;
Customer _customer;
常量(Constants) 类常量和ANSI常量的声明,应该全部大写,单词间用下划线隔开。(尽量避免ANSI常量,容易引起错误) static final int MIN_WIDTH = 4;
static final int MAX_WIDTH = 999;
static fina