JAVA编码规范V1.0要点计划.docxVIP

精品文档 精品文档 PAGE PAGE24 精品文档 PAGE Java编码规范 目录 1 说明 3 1.1 版本说明 3 1.1.1 V1.0 3 1.2 文档阅读说明 3 2 项目规范 3 2.1 项目编码 3 3 JAVA规范 3 3.1 建立 3 3.2 代码架构 4 3.3 排版 4 3.4 说明 6 3.5 命名 9 3.6 编码 12 3.7 性能与可靠性 19 4 附录 21 4.1 代码管理规范 21 4.2 MyEclipse优化设置 21 说明 1.1版本说明 V1.0 初始版本，根据  2013  年企业  J2EE版本规范修订而来。去除了  JavaScript规范（该部分 规划为未来独自整理）  ；去除了代码评审有关评审表格  （这部分该由项目管理流程提供）  ；去 除了项目目录规划部分的描绘（该规划后续独自提供）  。 1.2文档阅读说明 R：规则，必须恪守 S：建议，根据实际情况而定 项目规范 2.1项目编码 项目编码统一使用 utf-8进行编码，包括 java、jsp、js、css、properties、xml等。 3JAVA规范 3.1建立 R1Java项目均应采用 maven进行项目建立，并能实现经过命令行自动建立。 说明：采用 Maven或Gradle进行项目建立是 Java项目开发工作自动化的常有选项。 Gradle目前普及程度不及 Maven。故此企业决定采用 Maven作为项目建立的基础工具。 未来推广自动建立、 持续集成、代码自动审查等工作， 均依靠于项目最基础的标准化工 作。希望大家恪守。 3.2代码架构 S1  如果类在目前定义文件外被使用，则需要定义为  public 说明：Java强制要求每个  Java文件中有一个  public  种类的类。因此，  public  类和  Java 文件具有一一对应关系。这背后隐含着 Java语言介绍的代码组织规则。我们在编码过程中， 也应尽量按照该规则， 防止非public类在目前定义文件外被使用的情况。 如果需要被目前定 义文件外的类使用，请声明为 public，以增加代码可读性。 3.3排版 R1 程序块要采用缩进风格编写，代码缩进单位为 4个空格，不使用 Tab缩进。 说明：缩进使程序更易阅读，由于开发工具及开发操作系统环境统一，所以不使用 Tab 缩进。 【注】采用 Tab键和space键进行缩进是经常发生争议的地方。毫无疑问 Tab键缩进的便利 性远超space键。可是考虑到常用的代码审查工具都建议采用 space而不是tab缩进。因此， 为了未来代码格式化和代码审查的方便， 规定采用空格缩进的方式。 可在开发工具中设置采 用4个空格键替换 Tab R2 左分界符（如大括号‘{’）应在语句同一行，并与语句间隔一个空格，右分界符（如大括号‘}’）独占一行，同时与引用它们的语句左对齐。在函数体的开始、类和接口的 定义、以及if、for、do、while、switch、case语句中的程序或许static、,synchronized等语句块中都要采用如上的缩进方式。 示例: if(ab){ doStart(); } R3 每行语句字符不超过100字符，关于较长的语句、表达式或参数要分红多行书写，换行应按照逗号后边，操作符前面的原则。 示例： if(logger.isDebugEnabled()){ logger.debug(Sessiondestroyed,call-id +event.getSession().getCallId()); } R4 不允许把多个短语句写在一行中，即一行只写一条语句。 说明：阅读代码更为清晰 示例：如下例子不切合规范。 Objecto=newObject();Objectb=null; R5 if,for,do,while,case,switch,default等语句自占一行， 且if,for,do,while,switch等语句 的履行语句不论多少都要加括号  {},case的履行语句中如果定义变量必须加括号  {}。 说明：阅读代码更为清晰，减少错误产生 示例： if(ab){ doStart(); } casex:{ inti=9; } 【注】这里需要特别说明的是一种被称作 ifthen的情况。 R6 在两个以上的重点字、变量、常量进行平等操作时，它们之间的操作符之前、之后或 者前后要加空格；进行非平等操作时，如果是关系亲密的立刻操作符（如 .），后不应加 空格。 说明：阅读代码更为清晰 示例： if(  a==b ){ object A.doStart(); } a *=2; S1 类属性和类方法不要交错放置，不同存取范围的属性或许方法也尽量不要交错