java编程规范.txt

1、JAVA 编程规范 分类： - J2ME - Java - 编程其他 2004-11-11 10:05 11225人阅读 评论(6) 收藏 举报 1. 应用范围本规范应用于采用J2EE规范的项目中，所有项目中的JAVA代码（含JSP，SERVLET，JAVABEAN，EJB）均应遵守这个规范。同时，也可作为其它项目的参考。2. 设计类和方法2.1 创建具有很强内聚力的类方法的重要性往往比类的重要性更容易理解，方法是指执行一个统一函数的一段代码。类常被错误的视为是一个仅仅用于存放方法的容器。有些开发人员甚至把这种思路作了进一步的发挥，将他们的所有方法放入单个类之中。之所以不能正确的认识类的功能，

2、原因之一是类的实现实际上并不 程 的执行。 一个 程被编 时， 所有方法 放 单个类中 放 个类中，这 有 。 类的数 代码的执行并 的 ， 是 创建 于 和 的代码时，类的数 有时 很 的 。类应用将 的方法 一。类currency1含一“ 的方法时，类可以具有强 的内聚力。 类currency1含fifl不 的方法时，类 具有 的内聚力。应力创建内聚力比 强的类。fi数 程 currency1含fi并不 分 其他方法 一的方法。 这种，可以为这些不的方法创建一个”性收容类。创建类时，应 这个的含是。类的本目的是创建 的程 单。2.2 创建 和 用的方法1. 所有方法 执行 的 个方法 应执

3、行一项 的 ，它应 的 这项 。应 创建执行fi不同 的方法。创建 用方法有fi 。 将 更 容易。2. 方法 为 一 的 方法 一个方法于其他方法的 用时，为 其他方法“的方法。“的方法 和 比 ，因为它 更fi的因 。 的方法 于“的方法， 不可能 个方法 为的方法。要 方法具 强的 性，方法之一是 类 。创建方法时，设法将 个方法视为一个，其他程不应要 了解方法的内 作，方法也不应要了解它 的 程。这就是为 的方法应靠参数而不应靠全局 的原因。创建 用方法时，请考虑列指导原则：1) 将复杂进程放入 用方法。 应用程 用复杂的数学公式，请考虑将 个公式放入它 己的方法中。这样 用这些公式的

4、其他方法就不currency1含用于公式的实际代码。这样也可以更容易发现 公式 的问题。2) 将数据输入/输 （I/O）放入 用方法。 3) 将 用方法中可能要 的代码隔离。 某个进程经常 更，请将这个fi 的代码放入 用方法，以 以后可以更容易的进行 ，并 意中给其他进程问题的可能性。 4) 将业 规则封装 用方法中。业 规则常属于要 的代码类别，应 应用程 的其余 分隔开。其他方法不应业 规则，只有要 用的方法才 用这些规则。 3. 设计类和方法时，要达列目的： 1) 创建更 容易 和 的方法2) 创建具有强 内聚力的类3) 创建 用的方法4) 创建 的方法5) 方法具有 性6) 提方法的

5、扇入性7) 降低方法的扇 性2.3 编程原则1. 为方法和类赋予表性强的名字 为了 代码更 容易理解，最容易的方法之一是为 的方法赋予表性强的名字。函数名DoIt、GetIt的可读性很 CalculateSalesTax、 RetrieveUserID比。由缩写方法名 的代码很 理解和 ， 有理由再这样做了。给方法正确的命名，可 程 程的 和 作 的 观。请认真 待方法命名的 作，不要为了 键入操作 而降低方法的可理解。实际应用举：1) 给方法命名时应 小写字母混 用。 句子全 用 写字母，那阅读就非常 ，而 小写字母混 用的句子，阅读就很容易。 2) 方法名时不要 用缩写。 认为应用程 中的

6、某些 程应 用缩写，那请将这些 上注释，并确保 个人 所有时间内 用这些缩写。决不要 某些方法中 某些单词进行缩写，而 别的方法中却不 用缩写。 2. 为 个方法赋予单个退 点3. 创建方法时，始终 应显式地 它的作用域。 1) 真的想创建一个公用方法，请向代码阅读 明这一点。2) 通过为 个方法赋予一个明确 的作用域，可以 代码阅读 需要投入的 作 。应确保 为方法赋予最有意的作用域。 一个方法只被同一类中的另一个方法 用，那请将它创建 私有方法。 方法是从fi个类中的fi个方法中 用，请将明为公用方法。4. 用参数 方法之间传递数据应 用类 。一般， 的作用域越小越 。为了 类 ，方法之一

7、是将数据作为参数 不同方法之间传递，而不是让方法共享类 。1) 为 个参数指 数据类型。 2) 始终要 数进行检验，决不要假设 数据 有问题。程 员常犯的一个错误是 编写方法时假设数据 有问题。 初始编程阶段， 编写 用方法时，这样的假设并 碍。这时 全能够是参数的可值，并按要 提供这些值。 不 参数的数据进行检验，那列就 给 很 麻烦：另某个人创建了一个 用方法， 此人不允的值； 晚些时候添 了新的 用方法，并错误的传递了坏数据。 3. 命名约 所有 的 应遵循匈牙利命名法，它 用3字符前缀表 数据类型，3个字符的前缀 小写，前缀后 是由表意性强的一个单词 fi个单词 的名字，而 个单词的

8、写字母 写，其它字母小写，这样保了 名能够进行正确的 句。这样， 一个 名就可以 类型和 所存 的值的意 方 内容，这 代码句可读性强、更 容易理解。3.1 currency1、类 方法命名符类型命名约 子currency1l 全 小写。l 识符用点 分隔开。为了 currency1的名字更易读，Sun 公 建 currency1名中的 识符用点 分隔。l Sun 公 的 java 分 currency1用 识符 .java 开 。l 全局currency1的名字用 的 的 Internet 保 域名开 。局 currency1：interface.screens全局currency1：com

9、.rational.www. interface.screens类， l 类的名字应 用名词。l 个单词 一个字母应 写。l 用单词的缩写， 非它的缩写 经 为人， HTTP。Class Hello ;Class HelloWorld ;Interface Apple ;方法l 一个单词一般是 词。l 一个字母是小些， 是中间单词的 一个字母是 写。l 方法 一个 员 的值，方法名一般为get+ 员 名， 的值是bool ，一般以is作为前缀。l 方法 一个 员 的值，方法名一般为：set + 员 名。getName();setName();isFirst();l 一个字母小写，中间单词的 一

10、个字母 写。l 不要用_ int students;int i;int n;char c;btNew;(bt是Button的缩写)常 l 所有常 名均全 写，单词间以_隔开。int MAX_NUM;3.2 其它开发人员 上表中列举的类型，请currency1 通 理人员，由理人员中更新列表内容，不“ 用经确 的新 前缀。4. 用常 4.1 用常 1. 常数很容易 数据输入时 错 常数存 的要问题之一是 很容易 键入数字时 错，从而fi了数字的fl 。 ， 键入数字10876时，很容易的键入10867 18076。 理 和保 字的方法不同，编 器并不 fi了fl 和不正确的数字，有时单的错误 的

11、问题不 表现 ，而 问题表现 时，它们 以 的计错误的式 现，这些错误很 确 fl。用常 代常数时，编 器将 编 时检常 的有”性。 常不存 ，编 器 将这一通 ，并进行编 ，这可以 错误键入的数字的问题，只要常 有正确的值， 用常 的所有代码也有 用正确值。2. 常数很 不 更新3. 常 代码更容易阅读用常 后，的一个 是可 创建的代码更容易阅读。常数很不 观。也 常数非常了解， 其他人则本不明。通过理的给常 命名， 用这些常 的代码就 比 观了，更容易阅读。为常 赋予 的作用域，这 用 时的不同。 一个应用程 中 决不应 创建同的常 。发现 己复了一个常 ，请将原始的常 明至 的作用域，

12、常 可供用它的所有方法为 。5. 5.1 有点的 用于fi个目的的 为 点（fi点）的 。 点 所代表的意 程 的执行程有 ， 程 于不同fl 时，它所表 的意是不 的，这样就给程 的可读性和可 性了麻烦。5.2 只 常用 名和 名进行缩写需要 名进行缩写时，一 要注意个代码中缩写规则的一性。 ， 代码的某些域中 用Cnt，而 另一些域中 用Count，就 给代码 不 要的复杂性。名中 不要 现缩写。5.3 用统一的 词通过 放 一个 词，就可创建更 统一的 ，它们更容易理解，也更容易 。 ，请 用strCustomerFirst和strCustomerLast，而不要 用strFirstCu

13、stomer和strLastCustomer。词列表：词后缀明First一 中的 一个Last一 中的最后一个Next一 中的一个 Prev一 中的上一个Cur一 中的 前 5.4 用 式的 给 命名时，始终 要 用 的 式，以 其它开发人员 理解 所代表的意时的 。5.5 为 个 最 的数据类型这样能 内存的需 ， 代码的执行 ， 降低 错的可能性。用于 的数据类型可能 进行计所 的 。 这种，编 器不 行 错误，它只是 值符数据类型的要 。这类问题 。5.6 缩小 的作用域的作用域 于它应有的范围， 可 存 ，并 不再需要 后的很时间内 用。它们的要问题是， 类中的 方法 能 它们进行 ，

14、并 很 是 进行 的。用是作用域 的一个重要问题。 ， 缩小作用域将 应用程 的可靠性 的 。6. 代码的式 6.1 代码进行式 时，要达的目的1. 通过代码分 功能和 于理解的代码段， 代码更容易阅读和理解；2. 用 行和注释行，将程 中 上不 的代码分开。比 ： 明 分和代码句间的分隔； 的方法中， 不同功能的代码间的分隔。要 现 上混 的分隔， ：某一 功能代码中间用 行进行了分隔， 是 功能代码之间却 有分隔，这样 给程 阅读 错 。3. 为理解代码 而需要做的 作；4. 代码的阅读 不 进行假设；5. 代码 可能做式 明了。6.2 编程原则1. 要将fi个句放 同一行上 不论是 明，

15、是句 不要 一行上currency1写fi个。2. 缩进后 行 将 设 为某个值时，所有后 行的缩进fl 应 一行的 值同；用一个方法时，后 行缩进 一个参数的开始 ；将 属性设 为于表达式的计 时，请从后 分 句，以确保表达式 可能放 同一行上。3. if句后缩进； else句后缩进switch句后缩进case句后缩进do句后缩进经用行 符分 的句的个行要缩进从属于行 注的代码进行缩进。4. 执行统一 的个句之间 入一个 行。 的代码应由按 列的进程 句 。 7. 代码的注释7.1 用代码注释的目的1. 字明代码的作用(为要用编写代码,而不是 编写); 2. 确指 代码的编写思路和 方法;

16、3. 人们注意代码中的重要折点; 4. 代码的阅读 不 他们的 脑中仿真 行代码的执行方法.7.2 编程原则1. 用 字明代码的作用:单的重复代码做写,这样的注释 不能给注释 信息. 用 的命名方法创建 观明了的代码那这些类型的注释 不了信息.2. 想违背 的编程原则,请明为有的时候 可能需要违背 的编程原则， 用了某些不正规的方法，.这种时,请用内 注释明 做和为要这样做。技巧性 别的代码段，一 要 详细的注释，不要让其他开发人员花很时间研 一个技巧 不易理解的程 段。3. 用注释明 时可能 错和为 错4. 编写代码前进行注释给代码 注释的方法之一是 编写一个方法前 写上注释. 愿意,可以编

17、写 句子的注释 伪代码.一旦 用注释 代码进行了概,就可以 注释之间编写代码.5. 要注释的代码前currency1写注释注释一 现 要注释的程 段前，不要 某段程 后currency1写 这段程 的注释，注释 程 的理解 有一 帮助。有可能，请 注释行 上 代码间 一 行。6. 纯 字符注释行只用于要注释注释中要分隔时，请 用一行 注释行 ，不要 用纯 字符，以保持版 的洁、 晰。7. 注释框用星 围 的注释框，右边的星 很 , 它们给注释 了 信息吗?实际上这 给编写 编 注释的人 fi 作。8. 强注释的可读性注释是供人阅读的，而不是让计 阅读的。1) 用 的句。 不 将注释分 段落（最

18、 也不要分 段落）， 应 将注释写 的句子。 2) 用缩写。缩写常 注释更 阅读，人们常用不同的方法 同的单词进行缩写，这 fi混 ， 词汇缩写， 做统一。 3) 将个单词 写，以突 它们的重要性。要 人们注意注释中的一个 fi个单词，请全 用 写字母。 9. 注释进行缩进， 之 后 的句 齐。注释通常fl于它们要明的代码的前 。为了从视 上突 注释 它的代码之间的 ，请将注释缩进， 之代码 于同一个层上。10. 为 个方法赋予一个注释 个方法 应有一个注释 。方法的注释 可currency1含fi个 字项，比 输入参数、 值、原始作 、最后编 方法的程 员、上 日 、版权信息。11. 行 注

19、释用 上 这种代码段 中时，它们 代码更 阅读。用fi个行 注释时（比 用于方法顶 的fi个 明），应 它们fl 齐。这可 它们稍容易阅读一些。12. 时currency1写注释1) 请 个if句的前 上注释。 2) 个switch句的前 上注释。 if句一样，switch句用于评估 程 执行 的表达式。 3) 个循环的前 上注释。 个循环 有它的作用，fi这个作用不 观。 7.3 注释那些 分项目注释哪些 分实参/ 参数参数类型 参数用做约束 前提条字段/ 字段/属性字段描 注释所有 用的不 并行事可见性决策类类的目的 的问题类的开发/ 历史注释 采用的不 并行策略编 单一个类/类内 的 ，

20、含单的明 名和/ 识信息版权信息 目的 它应 被 用以 不被 用局 用 /目的员函数注释员函数做以 它为做这个 哪些参数 传递给一个 员函数员函数 的问题由某个 员函数抛 的异常可见性决策员函数是 象的currency1含 代码的历史 用 员函数的子用的前提条和后 条员函数内 注释控 代码做了些以 为这样做局 复杂的代码理 7.4 7.4.1 注释：要用描 ，类，方法，法。一般用 档和方法的前 ，也可以放 档的 地方。以/*开 ，*/ 。：/* 注释*/7.4.2 行注释：要用 方法内 ， 代码， ，程进行明。 注释式似， 是个注释 据一行。：/* 注释 */7.4.3 注释：行注释功能似，放

21、 代码的同行， 是要 代码之间有足够的 间， 于分 。：int m=4 ; /* 注释 */一个程 内有fi个 注释， 个注释的缩进应保持一。7.4.4 行 注释：行注释功能似，放 行的最后， 据一行。以/开 。7.4.5 档注释：注释似， 是可以被javadoc 理， HTML 。以/*开 ，*/ 。 档注释不能放方法 程 内。：/*注释*/8. 表达式和句8.1 行应只有一条句。8.2 if-else,if-elseif句， ， 应有”，”，式 ：if (condition) statements; else if (condition) statements; elsestatement

22、s;8.3 for句式 ：for (initialization; condition; update) statements;句为 ：for (initialization; condition; update) ;8.4 while句式 ：while (condition) statements;句为 :while (condition);8.5 do-while句式 ：do statements; while (condition);8.6 switch句， 个switch里 应currency1含default子句,式 ：switch (condition) case ABC:stat

23、ements;/* falls through */case DEF:statements;break;case XYZ:statements;break;default:statements;break;8.7 try-catch句式 ：try statements; catch (ExceptionClass e) statements; finally statements;9. 错误 理和异常事通常的思想是只 错误采用异常 理： 和编程错误，设 错误，被破坏的数据，耗 ，。通常的法则是 统 正常状态以 重载和硬失”状态，不应 异常。异常 理时可以采用 的日志 报告异常，currency1括异常发 的时刻。不要 用异常实现控程 程 。10. 封装、事 1. 非商 公用单封装2. 一个业 程单封装3. 一方法（）的 用应能 某一项功能 程，符 性4. 一方法（）的 用符ACID事 性5. fi方法（）的 用应currency1含 一个事 中11. 可移植性1. 不要 用 经被 为不赞 用的类 方法。2. 需要换行的话， 用 println 代替 字符串中 用“/n“。 3. 用separator()方法代替路径中的/” /” 。4. 用pathSeptarator()方法代替路径中的 : ” ;” 。