JAVA程序编写规范

《JAVA程序编写规范》由会员上传分享，免费在线阅读，更多相关内容在教育资源-天天文库。

1、JAVA程序编写规范文件编号：版本号：编制：日期：审核：日期：批准：日期：文件修订记录时间作者主要修订内容目录1目的12适用范围13裁剪指南14资源和工具15定义和缩写16职责17指南/规范27.1命名规范27.2文件样式37.3代码编写格式57.4命名约定（建议）67.5其它规范68记录7JAVA程序编写规范1目的为了保证程序代码的质量，提高程序的可靠性、可读性和一致性，特制定本规范。2适用范围本规范适用于公司所有使用JAVA语言的项目。3裁剪指南无。4资源和工具引用标准：CapabilityMatur

2、ityModel®Integration(CMMISM),Version1.1工具：MicrosoftWordMicrosoftExcelMicrosoftVisioSubVersion5定义和缩写无。6职责无。-7-JAVA程序编写规范1指南/规范1.1命名规范（1）Package的命名Package的名字应该都是由一个小写单词组成。packagenet.htjs.nssb.yhgl.person;（2）Class的命名类名的开头为大写字母，多单词组合时，每个单词头字母大写。classDocFlow（3

3、）Class变量的命名变量的名字必须用一个小写字母开头。后面的单词用大写字母开头。StringuserName;（4）Class函数的命名函数的名字必须用一个小写字母开头。后面的单词用大写字母开头。如voidaddRecRecord(RecRecordDatadata);（5）参数的命名参数的名字必须和变量的命名规范一致。userName,StringuserPass);（6）数组的命名数组应该总是用下面的方式来命名：byte[]names;（7）方法的参数使用有意义的参数命名，如使用和要赋值的字段一样的

4、名字或相关的名字：SetCounter(intsize){this.size=size;}SetCounter(intnewSize){this.size=newSize;-7-JAVA程序编写规范}1.1文件样式所有java文件都必须遵守以下样式规则：（1）类的全局变量必须注释。建议：函数体内的重要变量也需要注释。（2）函数说明必须有，且符合JAVA的标准。可被JAVADOC识别。必须包括的项目有：函数意义、参数、返回值、自定义异常、及其它重要事项。（3）类的注释：作者、类的意义、用法、及注意事项（如某

5、些资源的释放）。（4）函数体内部也应有适当注释。所有注释不低于25%。（5）Class（6）接下来的是类的注释，一般是用来解释类的。采用开发工具IDE自动生成注释框架/***

Title:类功能的一句话描述

Description:类功能及实现方法的描述

Copyright:Copyright(c)2004

Company:

6、ervableimplementsCloneable（8）ClassFields接下来是类的成员变量：/**-7-JAVA程序编写规范*Packetcounters*/protectedint[]packets;（1）public的成员变量必须采用上例的注释格式。（2）存取方法接下来是类变量的存取的方法。/***Getthecounters*@returnanarraycontainingthestatisticaldata.Thisarrayhasbeen*freshlyallocatedandcanb

7、emodifiedbythecaller.*/publicint[]getPackets(){returncopyArray(packets,offset);}（3）构造函数接下来是构造函数，它应该用递增的方式写（比如：参数多的写在后面）。访问类型("public","private"等)和任何"static","final"或"synchronized"应该在一行中，并且方法和参数另写一行，这样可以使方法和参数更易读。PublicCounterSet(intsize){this.size=size;}（

8、4）克隆方法如果这个类是可以被克隆的，那么下一步就是clone方法：PublicObjectclone(){try{CounterSetobj=(CounterSet)super.clone();obj.packets=(int[])packets.clone();obj.size=size;returnobj;-7-JAVA程序编写规范}catch(CloneNotSupportedExceptione){thrownewI