程序编码规范(java)

《程序编码规范(java)》由会员上传分享，免费在线阅读，更多相关内容在应用文档-天天文库。

1、项目管理系统程序编码规范V1.0程序编码规范V1.0编写：×××审核：×××××××年××月修改22项目管理系统程序编码规范V1.0目录一、引言3二、命名规范32.1包（Package）的命名32.2Class的命名42.3Class变量的命名42.4接口的命名52.5参数的命名52.6数组的命名52.6方法的参数6三注释规范63.1块注释(BlockComments)73.2单行注释(Single-LineComments)73.3尾端注释(TrailingComments)73.4行末注释(End-Of-LineComments)8四Java文件样式84.1版权信息84.2Package

2、/Imports94.3Class94.4ClassFields104.5存取方法104.6构造函数104.7main方法114.8换行(WrappingLines)114.9行长度(LineLength)134.10语句(Statements)13五排版格式18六JSP编码规范19七、文件与目录20八、日志规范20九、设计及技巧建议219.1表现层229.2业务层229.3持久层2222项目管理系统程序编码规范V1.0一、引言编码规范对于程序员而言尤为重要，有以下几个原因：1、一个软件的生命周期中，80%的花费在于维护。2、几乎没有任何一个软件，在其整个生命周期中，均由最初的开发人员来维护

3、。3、编码规范可以改善软件的可读性，可以让程序员尽快而彻底地理解新的代码。4、如果你将源码作为产品发布，就需要确任它是否被很好的打包并且清晰无误，一如已构建的其它任何产品为了执行规范，每个软件开发人员必须一致遵守编码规范中的代码规范，代码规范提高软件代码的可读性,使得开发人员快速和彻底的理解新代码.。好的代码风格不仅会提高可读性，而且会使代码更健壮，更为重要的是在修改时不容易出错。现代软件开发中，维护工作会占用80%的时间，而且开发者和维护者通常不是同一个程序员。这意味着程序员经常要阅读和修改别人开发的程序，别人也同样可能需要阅读和修改你开发的程序，所以制定一套完善的编码规范非常重要。定义本

4、规范的目的是使项目中所有的文档及程序编码在写作风格上具有一致性，增加可读性，减少项目组中因为换人带来的损失，从而使程序具有良好的可读性。二、命名规范2.1包（Package）的命名包(Packages)：一个唯一包名的前缀应全部为小写的ASCII字母，并且是一个顶级域名，通常为com、edu、gov、mil、net、org等。包名的后续部分可根据各个不同机构内部的命名规范来定义，这类命名规范可以由特定的目录名来区分部门(department)、项目(project)、机器(machine)和注册名(loginnames)。l核心程序部分：com.xxxxxx.basel系统管理部分：com.

5、xxxxxx.sys22项目管理系统程序编码规范V1.0l应用维护部分：com.xxxxxx.appconfigl项目计划管理部分：com.xxxxxx.itemplanl采购管理部分：com.xxxxxx.purchasel财务管理部分：com.xxxxxx.financel监测评价部分：com.xxxxxx.analyse如果在开发过程中还有其他情况没有涵盖到，可以按照上述规则进行扩展。2.2Class的命名Class的名字必须由一个大写字母开头其他字母为小写的单词构成。类名要用完整的单词，避免使用缩写词(除非该缩写词被更广泛使用，像URL，HTML)。ActionForm类的命名：以有

6、意义的拼音缩写开头后加ActionFormAction类的命名：以有意义的拼音缩写开头后加Action2.3Class变量的命名变量名应选用易于记忆、简短富于描述并能够指出其用途的单词。单词不应以下划线或美元符号开头，除一次性临时变量外尽量避免单个字符的变量名。除了变量名外，所有实例，包括类、类常量均采用大小写混合的方式，第一个单词的首字母小写，其后单词的首字母大写。charc（c、d、e常用于表示字符型）intI（i、j、k、m、n常用于表示整型）floatmyWidth;实例变量(InstanceVariables)大小写规则和变量名相似，但前面需要一个下划线int_employeeId

7、;String_name;Customer_customer;常量(Constants)类常量和ANSI常量的声明，应该全部大写，单词间用下划线隔开。(尽量避免ANSI常量，容易引起错误)staticfinalintMIN_WIDTH=4;staticfinalintMAX_WIDTH=999;staticfinalintGET_THE_CPU=1;22项目管理系统程序编码规范V1.0除了以下几个特例之外，命