1 / 22
文档名称:

程序编码规范(java).doc

格式:doc   大小:139KB   页数:22页
下载后只包含 1 个 DOC 格式的文档,没有任何的图纸或源代码,查看文件列表

如果您已付费下载过本站文档,您可以点这里二次下载

分享

预览

程序编码规范(java).doc

上传人:1006108867 2018/11/22 文件大小:139 KB

下载得到文件列表

程序编码规范(java).doc

相关文档

文档介绍

文档介绍::×××审核:×××××××年××月修改目录一、引言 3二、命名规范 (Package)的命名 6三注释规范 (ments) (Single-ments) (ments) (End-Of-ments) 8四Java文件样式 (WrappingLines) (LineLength) (Statements) 13五排版格式 18六JSP编码规范 19七、文件与目录 20八、日志规范 20九、设计及技巧建议 22一、引言编码规范对于程序员而言尤为重要,有以下几个原因:一个软件的生命周期中,80%的花费在于维护。几乎没有任何一个软件,在其整个生命周期中,均由最初的开发人员来维护。编码规范可以改善软件的可读性,可以让程序员尽快而彻底地理解新的代码。如果你将源码作为产品发布,就需要确任它是否被很好的打包并且清晰无误,一如已构建的其它任何产品为了执行规范,每个软件开发人员必须一致遵守编码规范中的代码规范,代码规范提高软件代码的可读性,使得开发人员快速和彻底的理解新代码.。好的代码风格不仅会提高可读性,而且会使代码更健壮,更为重要的是在修改时不容易出错。现代软件开发中,维护工作会占用80%的时间,而且开发者和维护者通常不是同一个程序员。这意味着程序员经常要阅读和修改别人开发的程序,别人也同样可能需要阅读和修改你开发的程序,所以制定一套完善的编码规范非常重要。定义本规范的目的是使项目中所有的文档及程序编码在写作风格上具有一致性,增加可读性,减少项目组中因为换人带来的损失,从而使程序具有良好的可读性。二、(Package)的命名 包(Packages):一个唯一包名的前缀应全部为小写的ASCII字母,并且是一个顶级域名,、edu、gov、、org等。包名的后续部分可根据各个不同机构内部的命名规范来定义,这类命名规范可以由特定的目录名来区分部门(department)、项目(project)、机器(machine)和注册名(loginnames)。.xxxxxx..xxxxxx..xxxxxx..xxxxxx..xxxxxx..xxxxxx..,可以按照上述规则进行扩展。。类名要用完整的单词,避免使用缩写词(除非该缩写词被更广泛使用,像URL,HTML)。ActionForm类的命名:以有意义的拼音缩写开头后加ActionFormAction类的命名:、简短富于描述并能够指出其用途的单词。单词不应以下划线或美元符号开头,除一次性临时变量外尽量避免单个字符的变量名。除了变量名外,所有实例,包括类、类常量均采用大小写混合的方式,第一个单词的首字母小写,其后单词的首字母大写。charc(c、d、e常用于表示字符型)intI(i、j、k、m、n常用于表示整型)floatmyWidth;实例变量(InstanceVariables)大小写规则和变量名相似,但前面需要一个下划线int_employeeId;String_name;Customer_customer;常量(Constants)类常量和ANSI常量的声明,应该全部大写,单词间用下划线隔开。(尽量避免ANSI常量,容易引起错误)staticfinalintMIN_WIDTH=4;staticfinalintMAX_WIDTH=999;staticfinalintGET_THE_CPU=1;除了以下几个特例之外,命名时应始终采用完整的英文描述符。此外,一般应采用小写字母,但类名、接口名以及任何非初始单词的第一个字母要大写。1、尽量使用完整的英文描述符2、采用适用于相关领域的术语3、采用大小写混合使名字可读4、尽量少用缩写,但如果用了,要明智地使用,且在整个工程中统一5、避免使用长的名字(小于15个字母是个好主意)6、避免使用类似的名字,或者仅仅是大小写不同的名字7、避免使用下划线(除表态常量等),如interfaceRast