《Java软件开发代码规范》由会员分享，可在线阅读，更多相关《Java软件开发代码规范（9页珍藏版）》请在金锄头文库上搜索。
1、Java软件开发代码规范俗话说无规矩不成方圆，在现实生活中，不管我们做什么事都讲究规则，软件开发也一样，无论你在什么样的软件开发公司，无论你从事安卓软件开发还是手机软件开发，都必须要遵循软公司的规则，软件开发的规则，行业的规则；我们只有遵循这些规则，有一个好的软件开发流程，才能一直很好的走下去，才能有进步，下面我和大家共同探讨一下软件开发的规则，也就是说我们开发一个软件需要满足哪些要求；有不中之处还望大家多多指点：(由于本人重点从事Java软件开发，所以重点说的是Java软件开发的规则，大同小异了)1、代码组织与风格 (1).关键词和操作符之间加适当的空格。 (2).相对独立的程序块与块之间加
2、空行 (3).较长的语句、表达式等要分成多行书写。 (4).划分出的新行要进行适应的缩进，使排版整齐，语句可读。 (5).长表达式要在低优先级操作符处划分新行，操作符放在新行之首。 (6).循环、判断等语句中若有较长的表达式或语句，则要进行适应的划分。 (7).若函数或过程中的参数较长，则要进行适当的划分。 (8).不允许把多个短语句写在一行中，即一行只写一条语句。 (9).函数或过程的开始、结构的定义及循环、判断等语句中的代码都要采用缩进风格。 2、软件开发中的注解 定义这个规范的目的是让项目中所有的文档都看起来像一个人写的，增加可读性，减少项目组中因为换人而带来的损失。（这些规范并不是一定
3、要绝对遵守，但是一定要让程序有良好的可读性）。Java 的语法与 C+ 及为相似，那么，你知道 Java 的注释有几种吗？是两种？ / 注释一行 /* . */ 注释若干行 不完全对，除了以上两种之外，还有第三种，文档注释： /* . */ 注释若干行，并写入 javadoc 文档 注释要简单明了。 String userName = null; /用户名 边写代码边注释，修改代码同时修改相应的注释，以保证注释与代码的一致性。 在必要的地方注释，注释量要适中。注释的内容要清楚、明了，含义准确，防 止注释二义性。保持注释与其描述的代码相邻，即注释的就近原则。 对代码的注释应放在其上方相邻位置，不
4、可放在下面。对数据结构的注释应放在 其上方相邻位置，不可放在下面；对结构中的每个域的注释应放在此域的右方； 同一结构中不同域的注释要对齐。 变量、常量的注释应放在其上方相邻位置或右方。 全局变量要有较详细的注释，包括对其功能、取值范围、哪些函数或过程存取它以 及存取时注意事项等的说明。 在每个源文件的头部要有必要的注释信息，包括：文件名；版本号；作者；生成日 期；模块功能描述（如功能、主要算法、内部各部分之间的关系、该文件与其它文 件关系等）；主要函数或过程清单及本文件历史修改记录等。 /* * Copy Right Information : Neusoft IIT * Project :
5、eTrain * JDK version used : jdk1.3.1 * Comments : config path * Version : 1.01 * Modification history :2003.5.1 * Sr Date Modified By Why & What is modified * 1. 2003.5.2 Kevin Gao new */ 在每个函数或过程的前面要有必要的注释信息，包括：函数或过程名称；功能描 述；输入、输出及返回值说明；调用关系及被调用关系说明等 /* * Description :checkout 提款 * param Hashtable
6、cart info * param OrderBean order info * return String */ public String checkout(Hashtable htCart, OrderBean orderBean) throws Exception javadoc注释标签语法 author 对类的说明 标明开发该类模块的作者 version 对类的说明 标明该类模块的版本 see 对类、属性、方法的说明 参考转向，也就是相关主题 param 对方法的说明 对方法中某参数的说明 return 对方法的说明 对方法返回值的说明 exception 对方法的说明 对方法可能抛
7、出的异常进行说明 3、软件开发中的命名规范 定 义这个规范的目的是让项目中所有的文档都看起来像一个人写的，增加可读性，减少项目组中因为换人而带来的损失。（这些规范并不是一定要绝对遵守，但是一定 要让程序有良好的可读性）较短的单词可通过去掉元音形成缩写；要不然最后自己写的代码自己都看不懂了，那可不行。 较长的单词可取单词的头几发符的优先级，并用括号明确表达式的操作顺序，避免使用默认优先级。使用匈牙利表示法 Package 的命名 Package 的名字应该都是由一个小写单词组成。 package com.neu.util Class 的命名 Class 的名字必须由大写字母开头而其他字母都小写的
8、单词组成,对于所有标识符，其中包含的所有单词都应紧靠在一起，而且大写中间单词的首字母。 public class ThisAClassName Class 变量的命名 变量的名字必须用一个小写字母开头。后面的单词用大写字母开头 userName , thisAClassMethod Static Final 变量的命名 static Final 变量的名字应该都大写，并且指出完整含义。 /* *DBConfig PATH */ public static final String DB_CONFIG_FILE_PATH =com.neu.etrain.dbconfig; 参数的命名 参数的名字
9、必须和变量的命名规范一致。 数组的命名 数组应该总是用下面的方式来命名： byte buffer; 而不是： byte buffer; 方法的参数 使用有意义的参数命名，如果可能的话，使用和要赋值的字段一样的名字： SetCounter(int size) this.size = size; 4、Java文件样式 所有的 Java(*.java) 文件都必须遵守如下的样式规则： 版权信息 版权信息必须在 java 文件的开头，比如： /* * Copyright ? 2000 Shanghai XXX Co. Ltd. * All right reserved. */ 其他不需要出现在 jav
10、adoc 的信息也可以包含在这里。 Package/Imports package 行要在 import 行之前，import 中标准的包名要在本地的包名之前，而且按照字母顺序排列。如果 import 行中包含了同一个包中的不同子目录，则应该用 * 来处理。 package .stats; import java.io.*; import java.util.Observable; import hotlava.util.Application; 这里 java.io.* 使用来代替InputStream and OutputStream 的。 Class 接下来的是类的注释，一般是用来解释类
11、的。 /* * A class representing a set of packet and byte counters * It is observable to allow it to be watched, but only * reports changes when the current set is complete */ 接下来是类定义，包含了在不同的行的 extends 和 implements public class CounterSet extends Observable implements Cloneable Class Fields 接下来是类的成员变量：
12、/* * Packet counters */ protected int packets; public 的成员变量必须生成文档（JavaDoc）。proceted、private和 package 定义的成员变量如果名字含义明确的话，可以没有注释。 存取方法 接下来是类变量的存取的方法。它只是简单的用来将类的变量赋值获取值的话，可以简单的写在一行上。 /* * Get the counters * return an array containing the statistical data. This array has been * freshly allocated and can
13、be modified by the caller. */ public int getPackets() return copyArray(packets, offset); public int getBytes() return copyArray(bytes, offset); public int getPackets() return packets; public void setPackets(int packets) this.packets = packets; 其它的方法不要写在一行上 构造函数 接下来是构造函数，它应该用递增的方式写（比如：参数多的写在后面）。 访问类型
14、 (public, private 等.) 和 任何 static, final 或 synchronized 应该在一行中，并且方法和参数另写一行，这样可以使方法和参数更易读。 public CounterSet(int size) this.size = size; 克隆方法 如果这个类是可以被克隆的，那么下一步就是 clone 方法： public Object clone() try CounterSet obj = (CounterSet)super.clone(); obj.packets = (int)packets.clone(); obj.size = size; return obj; catch(CloneNotSupportedException e) throw new InternalError(Unexpected CloneNotSUpportedException: + e.getMessage(); 类方法 下面开始写类的方法： /* * Set the packet counters * (such as when restoring from a database) */ protected final void setArray(int
