Java公共规范v1

《Java公共规范v1》由会员上传分享，免费在线阅读，更多相关内容在教育资源-天天文库。

1、编码规范与范例Java公共规范版权所有版本信息版本时间状态简要描述部门更改人批准人V1.02015/07/07N创建注：状态可以为N-新建、A-增加、M-更改、D-删除。目录1.概述21.1.文档目的21.2.范围21.3.规范定义原则21.4.相关文档21.5.参考文件22.排版布局32.1.规则32.2.建议43.注释43.1.规则43.2.建议84.命名104.1.规则104.2.建议125.编码135.1.规则135.2.建议156.性能与可靠性166.1.字符串处理166.2.集合176.

2、3.I/0操作196.4.异常处理216.5.日志237.编程惯例237.1.引用类变量和类方法237.2.常量237.3.变量赋值237.4.其它惯例248.代码检查258.1.CodeTemplate258.2.SourceFormat258.3.OrganizeImports258.4.JAVAWarnings258.5.FindBugs258.6.CheckStyle258.7.自查CheckList26第28页共26页1.概述1.1.文档目的用于指导开发和设计人员基于Java的设计和开发工

3、作，确保所开发的Java代码具有统一良好的可读性，符合通常优化准则的语句结构和使用用法，具有良好的维护性。同时也为Java设计评审和Java代码评审提供统一评审依据。1.2.范围本文档适用于以下应用场景：l本文档适用于ilean所有基于JAVA开发项目；l本文档涉及规范在新开发和维护代码中必须遵守；1.3.规范定义原则本文档内容定义及更新应遵循以下原则：l简单性原则文档只定义编码中应遵循的规则和建议，不作为Java技术提高资料，对一些规范的理解，可以查询相关的技术资料；l指导性原则：文档中尽量给出建

4、议的编写示例供开发人员；1.4.相关文档与本文档相关的文档还包括：lJava编码规范条目分类列表.xls1.5.参考文件·JavaProgrammingGuidelines,ScottAmbler,Ambysoft,Inc.–RationalUnifiedProcess·HowtoWriteDocCommentsfortheJavaDocTool(URLSunDeveloperNetwork)·RequirementsforWritingJavaAPISpecifications(URLSunDev

5、eloperNetwork)·JavaCodeConventions–SunMicrosystems·IBMWebSphereCommerceInformationCenter·IBMWebSphereCommerceprogrammingguideline第28页共26页1.排版布局1.1.规则1.1.1.程序块采用缩进风格编写，缩进的空格数为4个，不允许使用TAB缩进。说明：缩进使程序更易阅读，使用空格缩进可以适应不同操作系统与不同开发工具。可以通过Eclipse或编辑工具设置实现转换。1.1.

6、2.括号右，多个参数之间，二元运算符左右，for语句表达式之间用空格隔开。说明：使阅读代码更加清晰，该项通过Eclipse设置编码格式后，通过SourceFormat实现。例如：如下例子不符合规范for(inti=0;i

7、;i

8、r、do、while等语句的执行语句部分无论多少都要加括号{}。1.1.6.相对独立的程序块之间、变量说明之后必须加空行。下列情况应该总是使用一个空行：l两个方法之间。l方法内的局部变量和方法的第一条语句之间。l块注释或单行注释之前。l一个方法内的两个逻辑段之间，用以提高可读性。第28页共26页1.1.建议1.1.1.类属性和类方法不要交叉放置，不同存取范围的属性或者方法也尽量不要交叉放置。修饰符应该按照如下顺序排列：public,protected,默认,priva