程序编码规范设计(java).doc

《程序编码规范设计(java).doc》由会员分享，可在线阅读，更多相关《程序编码规范设计(java).doc（23页珍藏版）》请在淘文阁 - 分享文档赚钱的网站上搜索。

1、.程 序 编 码 规 范V1.0编写： 审核： 年 月修改.目 录一、引言 .3二、命名规范 .32.1 包（Package）的命名 .32.2 Class 的命名 .42.3 Class 变量的命名 .42.4 接口的命名 .52.5 参数的命名 .52.6 数组的命名 .52.6 方法的参数 .6三 注释规范 .63.1 块注释(Block Comments) .73.2 单行注释(Single-Line Comments) .73.3 尾端注释(Trailing Comments) .73.4 行末注释(End-Of-Line Comments) .8四 Java 文件样式 .84.1

2、版权信息 .84.2 Package/Imports.94.3 Class.94.4 Class Fields .104.5 存取方法 .104.6 构造函数 .104.7 main 方法 .114.8 换行(Wrapping Lines) .114.9 行长度(Line Length) .134.10 语句(Statements) .13五 排版格式 .18六 JSP 编码规范 .19七、文件与目录 .20八、日志规范 .20九、设计及技巧建议 .219.1 表现层 .229.2 业务层 .229.3 持久层 .22.一、引言编码规范对于程序员而言尤为重要，有以下几个原因：1、 一个软件的生

3、命周期中，80%的花费在于维护。2、 几乎没有任何一个软件，在其整个生命周期中，均由最初的开发人员来维护。3、 编码规范可以改善软件的可读性，可以让程序员尽快而彻底地理解新的代码。4、 如果你将源码作为产品发布，就需要确任它是否被很好的打包并且清晰无误，一如已构建的其它任何产品为了执行规范，每个软件开发人员必须一致遵守编码规范中的代码规范，代码规范提高软件代码的可读性 , 使得开发人员快速和彻底的理解新代码.。好的代码风格不仅会提高可读性，而且会使代码更健壮，更为重要的是在修改时不容易出错。现代软件开发中，维护工作会占用 80%的时间，而且开发者和维护者通常不是同一个程序员。这意味着程序员经常

4、要阅读和修改别人开发的程序，别人也同样可能需要阅读和修改你开发的程序，所以制定一套完善的编码规范非常重要。定义本规范的目的是使项目中所有的文档及程序编码在写作风格上具有一致性，增加可读性，减少项目组中因为换人带来的损失，从而使程序具有良好的可读性。二、命名规范 2.1 包（ Package）的命名包(Packages)： 一个唯一包名的前缀应全部为小写的 ASCII 字母，并且是一个顶级域名，通常为 com、edu、gov 、mil、net 、org 等。包名的后续部分可根据各个不同机构内部的命名规范来定义，这类命名规范可以由特定的目录名来区分部门(department)、项目(project

5、)、机器 (machine)和注册名 (login names)。. 核心程序部分：com.xxxxxx.base 系统管理部分：com.xxxxxx.sys 应用维护部分：com.xxxxxx.appconfig 项目计划管理部分：com.xxxxxx.itemplan 采购管理部分：com.xxxxxx.purchase 财务管理部分：com.xxxxxx .finance 监测评价部分：com.xxxxxx.analyse如果在开发过程中还有其他情况没有涵盖到，可以按照上述规则进行扩展。2.2 Class 的命名Class 的名字必须由一个大写字母开头其他字母为小写的单词构成。 类名要用

6、完整的单词，避免使用缩写词(除非该缩写词被更广泛使用，像 URL，HTML) 。ActionForm 类的命名：以有意义的拼音缩写开头后加 ActionFormAction 类的命名：以有意义的拼音缩写开头后加 Action2.3 Class 变量的命名变量名应选用易于记忆、简短富于描述并能够指出其用途的单词。单词不应以下划线或美元符号开头，除一次性临时变量外尽量避免单个字符的变量名。除了变量名外，所有实例，包括类、类常量均采用大小写混合的方式，第一个单词的首字母小写，其后单词的首字母大写。char c （ c、d、e 常用于表示字符型）int I （i、j、k、m、n 常用于表示整型）flo

7、at myWidth; 实例变量(Instance Variables) 大小写规则和变量名相似，但前面需要一个下划线 int _employeeId;String _name;Customer _customer; 常量(Constants) 类常量和 ANSI 常量的声明，应该全部大写，单词间用下划线隔开。(尽量避免 ANSI 常量，容易引起错误 ) static final int MIN_WIDTH = 4;.static final int MAX_WIDTH = 999;static final int GET_THE_CPU = 1;除了以下几个特例之外，命名时应始终采用完整的英

8、文描述符。此外，一般应采用小写字母，但类名、接口名以及任何非初始单词的第一个字母要大写。1、尽量使用完整的英文描述符2、采用适用于相关领域的术语3、采用大小写混合使名字可读4、尽量少用缩写，但如果用了，要明智地使用，且在整个工程中统一5、避免使用长的名字（小于 15 个字母是个好主意）6、避免使用类似的名字，或者仅仅是大小写不同的名字7、避免使用下划线（除表态常量等）2.4 接口的命名书写规则与类名相似，如 interface RasterDelegate；interface Storing；方法(Methods) ：方法名是一个动词，采用大小写混合的方式，第一个单词的首字母小写，其后单词的首

9、字母大写，例如： run();runFast();getBackground(); 2.5 参数的命名 参数的命名必须与变量的命名规范一致。2.6 数组的命名 数组应该用下面的方式来命名： byte buffer;.而不是： byte buffer;2.6 方法的参数 使用有意义的参数来命名，名字尽量和将要赋值的字段一致。例如： SetCounter(int size)this.size = size;三 注释规范一般情况下程序有两类注释：实现注释(implementation comments)和文档注释(document comments)。实现注释是那些在 C+中见过的，使用/*.*/和

10、/界定的注释。文档注释(称为“doc comments“)是 Java 独有的，并由/*.*/界定。文档注释可以通过javadoc 工具转换成 HTML 文件。实现注释用来注释代码或者实现细节。文档注释从实现自由(implementation-free)的角度描述代码的规范。它可以使手头没有源码的开发人员读懂程序。注释是用来对代码进行的，并提供代码自身没有提供的附加信息。注释要包含有助于阅读和理解程序的相关信息。例如，相应的包如何被建立或位于哪个目录下之类的信息不应包括在注释中。.程序可以有 4 种实现注释的风格：块(block)、单行(single-line)、尾端(trailing)和行末

11、(end-of-line)。3.1 块注释 (Block Comments)块注释通常是对文件、方法、数据结构和算法等提供描述，应置于每个文件的开始处或每个方法之前。块注释也可以用于其他地方，如方法的内部。在功能和方法内部的块注释应该和它所描述的代码具有一样的缩进格式。块注释之首应该有一个空行，用于把块注释和代码分割开来，比如：/* 在这里写块注释*/3.2 单行注释 (Single-Line Comments)单行注释之前也应该有一个空行。若为可以显示在一行内短注释，要与其后的代码具有一样的缩进层级。如果一个注释不能在一行内写完，就该采用块注释(参见“ 块注释“) 的方式。以下是一个 Jav

12、a 代码中单行注释的例子：if (condition) /* 判断条件 */.3.3 尾端注释 (Trailing Comments)极短的注释可以与它们所要描述的代码位于同一行，但是应该有足够的空白将代码和注释分开。若有多个短注释出现在大段代码中，它们应该具有相同的缩进。以下是一个 Java 代码中尾端注释的例子：.if (a = 2) return TRUE; /* special case */ else return isPrime(a); /* works only for odd a */3.4 行末注释 (End-Of-Line Comments)利用注释界定符“/“，可以注释掉

13、整行或者一行中的一部分。它一般不用于连续多行的注释文本中，常用来注释掉连续多行的代码段。以下是所有三种风格的例子：if (foo 1) / Do a double-flip.else return false; / Explain why here./if (bar 1) / / Do a triple-flip./ ./else / return false;/四 Java 文件样式所有的 Java(*.java) 文件都必须遵守如下的样式规则 4.1 版权信息版权信息必须在 java 文件的开头，比如： ./* 版权所有? *年-*年 科技有限公司，*保留所有权利。*/其他不需要出现在 j

14、avadoc 的信息也可以包含在这里。4.2 Package/Importspackage 行要在 import 行之前， import 中标准的包名要在本地的包名之前，而且按照字母顺序排列。如果 import 行中包含了同一个包中的不同子目录，则应该用 * 来处理。package com.aoch.ecity.;import java.io.*;import java.util.Observable;import hotlava.util.Application;这里 java.io.* 使用来代替 InputStream and OutputStream 的。4.3 Class类的注释一般

15、是用来解释类功能的，需要按照如下格式编写： /* 类名 : Jpc* 描述 : Jpc 服务的用户接口类，调用了 JpcService 类的实现。* * 版权声明: Copyright (c) 2003-2004，* 科技有限公司 * author 作者姓名.* version 1.5.6*/4.4 Class Fields类的成员变量必须通过注释说明其含义，不管成员变量是 public、protected 还是private 的都要说明。4.5 存取方法 若类的存取方法只是用于对类的变量赋值、取值的话，在类的成员变量有注释的情况下，类变量的存取方法可以没有注释。/* 功能说明： * para

16、m opcData 要设置的 Opc 数据* return true 成功 false 失败* throws ServiceUnavailableException 服务不可用异常*/public static boolean setDataToOpc(OpcData opcData) throws ServiceUnavailableException return true;public int getPackets(String s) return copyArray(packets, offset); public int getBytes() return copyArray(bytes, offset); public int getPackets() return packets; public void setPackets(int packets) this.packets = packets; 4.6 构造函数 构造函数，要用递增的方式书写（参数多的写在后面） ，这样可以使方法和参数更易