《java编码规范》doc版

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

1、设计说明书（XX）第一分册Java编码规范数据大集中零售业务组2004年10月【交通银行大集中工程】【内部资料请勿外泄】第2页共1页Java编码规范目录1前言31.1为什么要有编码规范32文件名42.1文件后缀42.2常用文件名43文件组织53.1Java源文件53.1.1开头注释53.1.2包和引入语句53.1.3类和接口声明64缩进排版74.1行长度74.2换行75注释105.1实现注释的格式105.1.1块注释105.1.2单行注释115.1.3尾端注释115.1.4行末注释125.2文档注释126声明146.1每行声明变量

2、的数量146.2初始化146.3布局146.4类和接口的声明157语句167.1简单语句167.2复合语句167.3返回语句167.4if，if-else，ifelse-ifelse语句167.5for语句177.6while语句177.7do-while语句187.8switch语句187.9try-catch语句188空白208.1空行208.2空格209命名规范22【交通银行大集中工程】【内部资料请勿外泄】-29-Java编码规范10编程惯例2410.1提供对实例以及类变量的访问控制2410.2引用类变量和类方法2410.3

3、常量2410.4变量赋值2410.5clone()方法2510.6toString()方法2510.7main()方法2510.8其它惯例2610.8.1圆括号2610.8.2返回值2610.8.3条件运算符"?"前的表达式2610.8.4特殊注释2711代码范例2811.1Java源文件范例28【交通银行大集中工程】【内部资料请勿外泄】-29-Java编码规范1前言1.1为什么要有编码规范编码规范对于程序员而言尤为重要，有以下几个原因：l一个软件的生命周期中，80%的花费在于维护l几乎没有任何一个软件，在其整个生命周期中，均由最

4、初的开发人员来维护l编码规范可以改善软件的可读性，可以让程序员尽快而彻底地理解新的代码l如果你将源码作为产品发布，就需要确任它是否被很好的打包并且清晰无误，一如你已构建的其它任何产品为了执行规范，每个软件开发人员必须一致遵守编码规范。1.2适用范围所有基于Java技术开发的系统都应遵循本规范，以使得编码风格得到统一，增强源代码的可维护性。1.3参考文献CodeConventionsfortheJavaTMProgrammingLanguagehttp://java.sun.com/docs/codeconv/html/CodeCo

5、nvTOC.doc.html【交通银行大集中工程】【内部资料请勿外泄】-29-Java编码规范1文件名这部分列出了常用的文件名及其后缀。1.1文件后缀Java程序使用下列文件后缀：文件类别文件后缀Java源文件.javaJava字节码文件.class1.2常用文件名常用的文件名包括：文件名用途GNUmakefilemakefiles的首选文件名。我们采用gnumake来创建（build）软件。README概述特定目录下所含内容的文件的首选文件名【交通银行大集中工程】【内部资料请勿外泄】-29-Java编码规范1文件组织一个文件由被

6、空行分割而成的段落以及标识每个段落的可选注释共同组成。超过2000行的程序难以阅读，应该尽量避免。"Java源文件范例"提供了一个布局合理的Java程序范例。1.1Java源文件每个Java源文件都包含一个单一的公共类或接口。若私有类和接口与一个公共类相关联，可以将它们和公共类放入同一个源文件。公共类必须是这个文件中的第一个类或接口。Java源文件还遵循以下规则：l开头注释（参见"开头注释"）l包和引入语句（参见"包和引入语句"）l类和接口声明（参见"类和接口声明"）1.1.1开头注释所有的源文件都应该在开头有一个C语言风格的注释

7、，其中列出类名、版本信息、日期和版权声明：/**Classname**Versioninformation**Date**Copyrightnotice*/1.1.2包和引入语句在多数Java源文件中，第一个非注释行是包语句。在它之后可以跟引入语句。例如：packagejava.awt;importjava.awt.peer.CanvasPeer;【交通银行大集中工程】【内部资料请勿外泄】-29-Java编码规范1.1.1类和接口声明下表描述了类和接口声明的各个部分以及它们出现的先后次序。参见"Java源文件范例"中一个包含注释的

8、例子。 类/接口声明的各部分注解1类/接口文档注释(/**……*/)该注释中所需包含的信息，参见"文档注释"2类或接口的声明 3类/接口实现的注释(/*……*/)如果有必要的话该注释应包含任何有关整个类或接口的信息，而这些信息又不适合作为类/接口文