首页 Java 程序编码规范

Java 程序编码规范

举报
开通vip

Java 程序编码规范 如果这个类是可以被克隆的,那么下一步就是 clone 方法: public Object clone() { try { CounterSet obj = (CounterSet)super.clone(); obj.packets = (int[])packets.clone(); obj.size = size; return obj; }catch(CloneNotSupportedException e) { ...

Java 程序编码规范
如果这个类是可以被克隆的,那么下一步就是 clone 方法 快递客服问题件处理详细方法山木方法pdf计算方法pdf华与华方法下载八字理论方法下载 : 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[] r1, int[] r2, int[] r3, int[] r4) throws IllegalArgumentException { // // Ensure the arrays are of equal size // if (r1.length != r2.length || r1.length != r3.length || r1.length != r4.length) throw new IllegalArgumentException("Arrays must be of the same size"); System.arraycopy(r1, 0, r3, 0, r1.length); System.arraycopy(r2, 0, r4, 0, r1.length); } toString 方法 无论如何,每一个类都应该定义 toString 方法: public String toString() { String retval = "CounterSet: "; for (int i = 0; i < data.length(); i++) { retval += data.bytes.toString(); j a v a ? ? ? ? :h t t p :/ /5 1c cs j .t a o b a o .c o m / j a v a ? ? ? ? :h t t p :/ /c h e n g ch e n g t e ch .t a o b a o .c o m / retval += data.packets.toString(); } return retval; } } main 方法 如果main(String[]) 方法已经定义了, 那么它应该写在类的底部. 代码编写格式 代码样式 代码应该用 unix 的格式,而不是 windows 的(比如:回车变成回车+换行) 文档化 必须用 javadoc 来为类生成文档。不仅因为它是 标准 excel标准偏差excel标准偏差函数exl标准差函数国标检验抽样标准表免费下载红头文件格式标准下载 ,这也是被各种 java 编译器都认可的方法。使用 @author 标记是不被推 荐的,因为代码不应该是被个人拥有的。 缩进 缩进应该是每行 2个空格. 不要在源文件中保存Tab字符. 在使用不同的源代码管理工具时Tab字符将因为用户设置的不同而扩展 为不同的宽度. 如果你使用 UltrEdit 作为你的 Java 源代码编辑器的话,你可以通过如下操作来禁止保存Tab字符, 方法是通过 UltrEdit中先设 定 Tab 使用的长度室 2个空格,然后用 Format|Tabs to Spaces 菜单将 Tab 转换为空格。 页宽 页宽应该设置为 80字符. 源代码一般不会超过这个宽度, 并导致无法完整显示, 但这一设置也可以灵活调整. 在任何情况下, 超长 的语句应该在一个逗号或者一个操作符后折行. 一条语句折行后, 应该比原来的语句再缩进 2个字符. {} 对 {} 中的语句应该单独作为一行. 例如, 下面的第 1行是错误的, 第 2行是正确的: if (i>0) { i ++ }; // 错误, { 和 } 在同一行 if (i>0) { i ++ }; // 正确, { 单独作为一行 } 语句永远单独作为一行. 如果 } 语句应该缩进到与其相对应的 { 那一行相对齐的位置。 括号 左括号和后一个字符之间不应该出现空格, 同样, 右括号和前一个字符之间也不应该出现空格. 下面的例子说明括号和空格的错 误及正确使用: j a v a ? ? ? ? :h t t p :/ /5 1c cs j .t a o b a o .c o m / j a v a ? ? ? ? :h t t p :/ /c h e n g ch e n g t e ch .t a o b a o .c o m / CallProc( AParameter ); // 错误 CallProc(AParameter); // 正确 不要在语句中使用无意义的括号. 括号只应该为达到某种目的而出现在源代码中。下面的例子说明错误和正确的用法: if ((I) = 42) { // 错误 - 括号毫无意义 if (I == 42) or (J == 42) then // 正确 - 的确需要括号 程序编写规范 exit() exit 除了在 main 中可以被调用外,其他的地方不应该调用。因为这样做不给任何代码代码机会来截获退出。一个类似后台服 务地程序不应该因为某一个库模块决定了要退出就退出。 异常 申明的错误应该抛出一个RuntimeException或者派生的异常。 顶层的main()函数应该截获所有的异常,并且打印(或者记录在日志中)在屏幕上。 垃圾收集 JAVA使用成熟的后台垃圾收集技术来代替引用计数。但是这样会导致一个问 快递公司问题件快递公司问题件货款处理关于圆的周长面积重点题型关于解方程组的题及答案关于南海问题 :你必须在使用完对象的实例以后进行清场工作。 比如一个prel的程序员可能这么写: ... { FileOutputStream fos = new FileOutputStream(projectFile); project.save(fos, "IDE Project File"); } ... 除非输出流一出作用域就关闭,非引用计数的程序语言,比如JAVA,是不能自动完成变量的清场工作的。必须象下面一样写: FileOutputStream fos = new FileOutputStream(projectFile); project.save(fos, "IDE Project File"); fos.close(); Clone 下面是一种有用的方法: implements Cloneable public Object clone() { try { ThisClass obj = (ThisClass)super.clone(); obj.field1 = (int[])field1.clone(); j a v a ? ? ? ? :h t t p :/ /5 1c cs j .t a o b a o .c o m / j a v a ? ? ? ? :h t t p :/ /c h e n g ch e n g t e ch .t a o b a o .c o m / obj.field2 = field2; return obj; } catch(CloneNotSupportedException e) { throw new InternalError("Unexpected CloneNotSUpportedException: " + e.getMessage()); } } final 类 绝对不要因为性能的原因将类定义为 final 的(除非程序的框架要求) 如果一个类还没有准备好被继承,最好在类文档中注明,而不要将她定义为 final 的。这是因为没有人可以保证会不会由于什么 原因需要继承她。 访问类的成员变量 大部分的类成员变量应该定义为 protected 的来防止继承类使用他们。 注意,要用"int[] packets",而不是"int packets[]",后一种永远也不要用。 public void setPackets(int[] packets) { this.packets = packets; } CounterSet(int size) { this.size = size; } 编程技巧 byte 数组转换到 characters 为了将 byte 数组转换到 characters,你可以这么做: "Hello world!".getBytes(); Utility 类 Utility 类(仅仅提供方法的类)应该被申明为抽象的来防止被继承或被初始化。 初始化 下面的代码是一种很好的初始化数组的方法: objectArguments = new Object[] { arguments }; 枚举类型 JAVA 对枚举的支持不好,但是下面的代码是一种很有用的模板: j a v a ? ? ? ? :h t t p :/ /5 1c cs j .t a o b a o .c o m / j a v a ? ? ? ? :h t t p :/ /c h e n g ch e n g t e ch .t a o b a o .c o m / class Colour { public static final Colour BLACK = new Colour(0, 0, 0); public static final Colour RED = new Colour(0xFF, 0, 0); public static final Colour GREEN = new Colour(0, 0xFF, 0); public static final Colour BLUE = new Colour(0, 0, 0xFF); public static final Colour WHITE = new Colour(0xFF, 0xFF, 0xFF); } 这种技术实现了RED, GREEN, BLUE 等可以象其他语言的枚举类型一样使用的常量。 他们可以用 '==' 操作符来比较。 但是这样使用有一个缺陷:如果一个用户用这样的方法来创建颜色 BLACK new Colour(0,0,0) 那么这就是另外一个对象,'=='操作符就会产生错误。她的 equal() 方法仍然有效。由于这个原因,这个技术的缺陷最好注明 在文档中,或者只在自己的包中使用。 Swing 避免使用 AWT 组件 混合使用 AWT 和 Swing 组件 如果要将 AWT 组件和 Swing 组件混合起来使用的话,请小心使用。实际上,尽量不要将他们混合起来使用。 滚动的 AWT 组件 AWT 组件绝对不要用 JscrollPane 类来实现滚动。滚动 AWT 组件的时候一定要用 AWT ScrollPane 组件来实现。 避免在 InternalFrame 组件中使用 AWT 组件 尽量不要这么做,要不然会出现不可预料的后果。 Z-Order 问题 AWT 组件总是显示在 Swing 组件之上。当使用包含 AWT 组件的 POP-UP 菜单的时候要小心,尽量不要这样使用。 调试 调试在软件开发中是一个很重要的部分,存在软件生命周期的各个部分中。调试能够用配置开、关是最基本的。 很常用的一种调试方法就是用一个 PrintStream 类成员,在没有定义调试流的时候就为 null,类要定义一个 debug 方法来设 置调试用的流。 性能 j a v a ? ? ? ? :h t t p :/ /5 1c cs j .t a o b a o .c o m / j a v a ? ? ? ? :h t t p :/ /c h e n g ch e n g t e ch .t a o b a o .c o m / 在写代码的时候,从头至尾都应该考虑性能问题。这不是说时间都应该浪费在优化代码上,而是我们时刻应该提醒自己要注意 代码的效率。比如:如果没有时间来实现一个高效的算法,那么我们应该在文档中记录下来,以便在以后有空的时候再来实现 她。 不是所有的人都同意在写代码的时候应该优化性能这个观点的,他们认为性能优化的问题应该在项目的后期再去考虑,也就是 在程序的轮廓已经实现了以后。 不必要的对象构造 不要在循环中构造和释放对象 使用 StringBuffer 对象 在处理 String 的时候要尽量使用 StringBuffer 类,StringBuffer 类是构成 String 类的基础。String 类将 StringBuffer 类封装 了起来,(以花费更多时间为代价)为开发人员提供了一个安全的接口。当我们在构造字符串的时候,我们应该用 StringBuffer 来 实现大部分的工作,当工作完成后将 StringBuffer 对象再转换为需要的 String 对象。比如:如果有一个字符串必须不断地在其 后添加许多字符来完成构造,那么我们应该使用 StringBuffer 对象和她的 append() 方法。如果我们用 String 对象代 替 StringBuffer 对象的话,会花费许多不必要的创建和释放对象的 CPU 时间。 避免太多的使用 synchronized 关键字 避免不必要的使用关键字 synchronized,应该在必要的时候再使用她,这是一个避免死锁的好方法。 可移植性 Borland Jbulider 不喜欢 synchronized 这个关键字,如果你的断点设在这些关键字的作用域内的话,调试的时候你会发现的 断点会到处乱跳,让你不知所措。除非必须,尽量不要使用。 换行 如果需要换行的话,尽量用 println 来代替在字符串中使用"\n"。 你不要这样: System.out.print("Hello,world!\n"); 要这样: System.out.println("Hello,world!"); 或者你构造一个带换行符的字符串,至少要象这样: String newline = System.getProperty("line.separator"); System.out.println("Hello world" + newline); PrintStream j a v a ? ? ? ? :h t t p :/ /5 1c cs j .t a o b a o .c o m / j a v a ? ? ? ? :h t t p :/ /c h e n g ch e n g t e ch .t a o b a o .c o m / PrintStream 已经被不赞成(deprecated)使用,用 PrintWrite 来代替她。 (此贴来源于网络,不好意思不知道是那个网站的了) j a v a ? ? ? ? :h t t p :/ /5 1c cs j .t a o b a o .c o m / j a v a ? ? ? ? :h t t p :/ /c h e n g ch e n g t e ch .t a o b a o .c o m /
本文档为【Java 程序编码规范】,请使用软件OFFICE或WPS软件打开。作品中的文字与图均可以修改和编辑, 图片更改请在作品中右键图片并更换,文字修改请直接点击文字进行修改,也可以新增和删除文档中的内容。
该文档来自用户分享,如有侵权行为请发邮件ishare@vip.sina.com联系网站客服,我们会及时删除。
[版权声明] 本站所有资料为用户分享产生,若发现您的权利被侵害,请联系客服邮件isharekefu@iask.cn,我们尽快处理。
本作品所展示的图片、画像、字体、音乐的版权可能需版权方额外授权,请谨慎使用。
网站提供的党政主题相关内容(国旗、国徽、党徽..)目的在于配合国家政策宣传,仅限个人学习分享使用,禁止用于任何广告和商用目的。
下载需要: 免费 已有0 人下载
最新资料
资料动态
专题动态
is_740086
暂无简介~
格式:pdf
大小:323KB
软件:PDF阅读器
页数:7
分类:工学
上传时间:2012-10-08
浏览量:26