java语言编码规范

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

1、Java编码规范密级：内部公开文档编号：版本号：V1.0分册名称：第1册/共1册Java编码规范编制：生效日期：审核：批准：文件更改摘要：日期版本号修订说明修订人审核人批准人第24页共25页Java编码规范第24页共25页Java编码规范目录1.介绍41.1为什么要有编码规范41.2注意事项42.文件名42.1文件后缀42.2常用文件名43.文件组织53.1Java源文件53.1.1包和引入语句53.1.2类和接口声明54.缩进排版64.1行长度64.2换行64.3对于{}85.注释85.1实现注释的格式85.1.1块注释85.1.2单行注释9

2、5.1.3尾端注释95.1.4行末注释95.2文档注释105.3注释内容105.3.1方法注释105.3.2算法注释115.3.3可精简的注释内容115.3.4推荐的注释内容115.3.5Null的规约115.3.6特殊代码注释126.声明126.1每行声明变量的数量126.2初始化126.3布局126.4类和接口的声明136.5声明规则147.语句147.1简单语句147.2复合语句14第24页共25页Java编码规范7.3返回语句147.4if，if-else，ifelse-ifelse语句157.5for语句157.6while语句167

3、.7do-while语句167.8switch语句167.9try-catch语句168.空白178.1空行178.2空格179.命名规范189.1命名规则199.1.1包命名199.1.2类、接口命名199.1.3方法命名199.1.4变量命名209.1.5常量命名2010.编程惯例2010.1提供对实例以及类变量的访问控制2010.2引用类变量和类方法2010.3常量2010.4变量赋值2110.5异常处理2110.6其它惯例2110.6.1圆括号2110.6.2返回值2110.6.3条件运算符“?”前的表达式*2211.信息输出2212.

4、代码范例2212.1Java源文件范例22第24页共25页Java编码规范1.介绍1.1为什么要有编码规范编码规范对于程序员而言尤为重要，有以下几个原因：l一个软件的生命周期中，80%的花费在于维护；l几乎没有任何一个软件，在其整个生命周期中，均由最初的开发人员来维护；l编码规范可以改善软件的可读性，可以让程序员尽快而彻底地理解新的代码；l如果你将源码作为产品发布，就需要确任它是否被很好的打包并且清晰无误，一如你已构建的其它任何产品。制定本规范的目的是为了让代码清晰整洁、增强可读性。所有编码必须围绕此原则，即使是本规范中未特别指明1.2注意事项

5、l本文档未特别标注的都必须遵守(不遵守将代表代码不合格，会给团队其他成员带来不便和困扰，大大提高总体维护成本)2.文件名这部分列出了常用的文件名及其后缀。2.1文件后缀Java程序使用下列文件后缀：文件类别文件后缀Java源文件.javaJava字节码文件.classJSP文件.jspXML文件.xml资源文件.properties日志文件.logTaglib文件.tldJava包文件.jar层叠样式表文件.css2.2常用文件名常用的文件名包括：第24页共25页Java编码规范文件名用途Build.xmlAnt编译配置Web.xmlJavaW

6、eb程序的配置文件Server.xmlTomcat的配置文件log4j.propertiesLog4j配置文件hibernate.cfg.xmlHibernate配置文件ApplicationResources.properties程序的英文资源文件ApplicationResources_zh_CN.properties程序的gbk资源文件struts-config-**.xmlStruts配置文件applicationContext-***.xmlSpring配置文件3.文件组织一个文件由被空行分割而成的段落以及标识每个段落的可选注释共同组

7、成。超过2000行的程序难以阅读，应该尽量避免。“Java源文件范例”提供了一个布局合理的Java程序范例。3.1Java源文件每个Java源文件都包含一个单一的公共类或接口。若私有类和接口与一个公共类相关联，可以将它们和公共类放入同一个源文件。公共类必须是这个文件中的第一个类或接口。Java源文件还遵循以下规则：Ø包和引入语句Ø类和接口声明3.1.1包和引入语句在Java源文件中，第一个非注释行是包语句。在它之后可以跟引入语句。例如：packagejava.awt;importjava.awt.peer.CanvasPeer;import顺序

8、：系统，第三方，自定义3.1.2类和接口声明下表描述了类和接口声明的各个部分以及它们出现的先后次序。参见代码范例类/接口声明的各部分注释1类/接口文档