- 浏览: 232591 次
- 性别:
- 来自: 西安
文章分类
最新评论
-
qwe2252099:
给力!简单易懂
两个java web服务间SoapMessage对象的传递 -
mimang2007110:
不是自带的,自己编辑过的
java代码模板 -
墨子宇:
貌似不是带有箭头的
CSS带箭头的导航菜单 -
墨子宇:
借鉴一下。不是自带的那个吧
java代码模板 -
墨子宇:
看名字应该是注释模板吧
myeclipse编码模板
所有的程序开发手册都包含了各种规则。一些习惯自由程序人员可能对这些规则很不适应,但是在多个开发人员共同写作的情况下,这些规则是必需的。这不仅仅是为了开发效率来考虑,而且也是为了后期维护考虑。
命名规范
定义这个规范的目的是让项目中所有的文档都看起来像一个人写的,增加可读性,减少项目组中因为换人而带来的损失。(这些规范并不是一定要绝对遵守,但是一定要让程序有良好的可读性)
-
数组的命名
数组应该总是用下面的方式来命名:
而不是:byte[] buffer;
byte buffer[];
-
方法的参数
使用有意义的参数命名,如果可能的话,使用和要赋值的字段一样的名字:SetCounter(int size){ this.size = size; }
Java 文件样式
所有的 Java(*.java) 文件都必须遵守如下的样式规则
-
版权信息
版权信息必须在 java 文件的开头,比如:
其他不需要出现在 javadoc 的信息也可以包含在这里。/** * Copyright ? 2000 Shanghai XXX Co. Ltd. * All right reserved. */
-
Package/Imports
package 行要在 import 行之前,import 中标准的包名要在本地的包名之前,而且按照字母顺序排列。如果 import 行中包含了同一个包中的不同子目录,则应该用 * 来处理。
这里 java.io.* 使用来代替InputStream and OutputStream 的。package hotlava.net.stats; import java.io.*; import java.util.Observable; import hotlava.util.Application;
-
Class
接下来的是类的注释,一般是用来解释类的。
接下来是类定义,包含了在不同的行的 extends 和 implements/** * 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 */
public class CounterSet extends Observable implements Cloneable (如果引入的类和接口很多,建议换行,转载者注)
-
Class Fields
接下来是类的成员变量:
public 的成员变量必须生成文档(JavaDoc)。proceted、private和 package 定义的成员变量如果名字含义明确的话,可以没有注释。/** * Packet counters */ protected int[] packets;
-
存取方法
接下来是类变量的存取的方法。它只是简单的用来将类的变量赋值获取值的话,可以简单的写在一行上。
其它的方法不要写在一行上/** * Get the counters * @return an array containing the statistical data. This array has been * freshly allocated and can 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; }
(个人觉得都分行比较好,保持一个一致的风格,转载者注)
- 构造函数
接下来是构造函数,它应该用递增的方式写(比如:参数多的写在后面)。
访问类型 ("public", "private" 等.) 和 任何 "static", "final" 或 "synchronized" 应该在一行中,并且方法和参数另写一行,这样可以使方法和参数更易读。 - (这在JDK 5中,有可变参数的情况下,格外重要,转载者注)
-
-
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[] 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(); retval += data.packets.toString(); } return retval; } }
- 缩进
缩进应该是每行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 ++ }; // 正确, { 单独作为一行 } 语句永远单独作为一行.
- 括号
左括号和后一个字符之间不应该出现空格, 同样, 右括号和前一个字符之间也不应该出现空格. 下面的例子说明括号和空格的错误及正确使用:
CallProc( AParameter ); // 错误
CallProc(AParameter); // 正确
不要在语句中使用无意义的括号. 括号只应该为达到某种目的而出现在源代码中。下面的例子说明错误和正确的用法:
if ((I) = 42) { // 错误 - 括号毫无意义
if (I == 42) or (J == 42) then // 正确 - 的确需要括号
- 异常
申明的错误应该抛出一个RuntimeException或者派生的异常。
顶层的main()函数应该截获所有的异常,并且打印(或者记录在日志中)在屏幕上。
(不要随意封装exception,转载者注) -
-
-
-
垃圾收集
JAVA使用成熟的后台垃圾收集技术来代替引用计数。但是这样会导致一个问题:你必须在使用完对象的实例以后进行清场工作。比如一个prel的程序员可能这么写:
除非输出流一出作用域就关闭,非引用计数的程序语言,比如JAVA,是不能自动完成变量的清场工作的。必须象下面一样写:... { FileOutputStream fos = new FileOutputStream(projectFile); project.save(fos, "IDE Project File"); } ...
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(); 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; }
-
枚举类型
JAVA 对枚举的支持不好,但是下面的代码是一种很有用的模板: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); } (JDK5以后推荐使用枚举了,转载者注)
-
-
-
-
-
- 这种技术实现了RED, GREEN, BLUE 等可以象其他语言的枚举类型一样使用的常量。 他们可以用 '==' 操作符来比较。
但是这样使用有一个缺陷:如果一个用户用这样的方法来创建颜色 BLACK
new Colour(0,0,0)
那么这就是另外一个对象,'=='操作符就会产生错误。她的 equal() 方法仍然有效。由于这个原因,这个技术的缺陷最好注明在文档中,或者只在自己的包中使用。
- 调试在软件开发中是一个很重要的部分,存在软件生命周期的各个部分中。调试能够用配置开、关是最基本的。
很常用的一种调试方法就是用一个 PrintStream 类成员,在没有定义调试流的时候就为 null,类要定义一个 debug 方法来设置调试用的流。
- 在写代码的时候,从头至尾都应该考虑性能问题。这不是说时间都应该浪费在优化代码上,而是我们时刻应该提醒自己要注意代码的效率。比如:如果没有时间来实现一个高效的算法,那么我们应该在文档中记录下来,以便在以后有空的时候再来实现她。
不是所有的人都同意在写代码的时候应该优化性能这个观点的,他们认为性能优化的问题应该在项目的后期再去考虑,也就是在程序的轮廓已经实现了以后。
-
不必要的对象构造
- 使用 StringBuffer 对象
在处理 String 的时候要尽量使用 StringBuffer 类,StringBuffer 类是构成 String 类的基础。String 类将 StringBuffer 类封装了起来,(以花费更多时间为代价)为开发人员提供了一个安全的接口。当我们在构造字符串的时候,我们应该用 StringBuffer 来实现大部分的工作,当工作完成后将 StringBuffer 对象再转换为需要的 String 对象。比如:如果有一个字符串必须不断地在其后添加许多字符来完成构造,那么我们应该使用 StringBuffer 对象和她的 append() 方法。如果我们用 String 对象代替 StringBuffer 对象的话,会花费许多不必要的创建和释放对象的 CPU 时间。
- 使用 StringBuffer 对象
- 换行
如果需要换行的话,尽量用 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);
- 查找有关 Thread 类和 Java 2 平台,标准版,API 规范的其他方面的信息。
发表评论
-
HttpClient各种使用方法
2014-08-27 15:25 1392最近项目中用到了模拟HTTP请求的部分,下面做了一个小整合 ... -
java中BCD编码
2014-08-09 11:20 3385Java中实现的BCD编码,供有兴趣的参考,欢迎批评指正 ... -
Android数据库操作的两种方式
2014-07-10 16:56 969Android操作数据库分文两种方式,一种是自己写sql脚本 ... -
Apache Ftp Server与spring框架融合
2014-04-01 16:33 6604最近在写一个项目,需要用到FTP服务,就从网上搜了一下,发现 ... -
Apache Ftp Server使用说明
2014-04-01 15:45 652最近公司项目需要一个FTP服务器,就从网上搜了一下发现Apac ... -
编程从业 5 年后的 14 条经验
2013-04-20 14:57 7871. 当性能遇到问题时,如果能在应用层进行计算和处理,那就把 ... -
Spring自己的轻量级定时器的两种实现方式
2013-03-04 19:35 1149Spring自己本身的轻量级 ... -
Java获取当前路径
2013-03-04 12:17 8121、利用System.getProperty()函数获取当 ... -
java udp通信
2012-12-12 11:39 1171java服务器部分: public static vo ... -
java 实现ftp的文件上传和删除
2012-12-01 11:49 17366package com.tw.ftp; impor ... -
java操作FTP,实现文件上传下载删除操作
2012-12-01 11:07 16918上传文件到FTP服务器: ... -
java下载文件的四种方式
2012-11-30 15:30 923try { ... -
模拟HTTPClient发送消息到服务器
2012-07-16 14:36 981// 存储服务器的响应消息 Stri ... -
两个java web服务间SoapMessage对象的传递
2012-07-14 15:51 1927客户端代码: try { ... -
字符串转换成SoapMessage对象
2012-07-14 15:40 4254下面的代码可以把字符串转换成SoapMessage对象 ... -
SoapMessage对象转换成字符串
2012-07-14 15:36 6378下面的代码可以把一个SoapMessage对象转换成字符串对象 ... -
手动修改和启动在spring配置文件中配置的定时器
2012-07-12 20:50 20911、创建业务处理类 public class Task ... -
手动利用spring提供的quartz创建定时器
2012-07-12 20:41 2988手动创建并启动定时器方法: /** * & ... -
spring定时器的创建和配置
2012-07-12 20:38 68311、创建业务处理类 public class Palp ... -
spring管理日志的例子
2012-05-07 15:32 774Spring 带给我们的另一个好处就是让我们可以“专心做 ...
相关推荐
Java程序编码规范 比较全的Java程序编码规范
Java程序编码规范.docJava程序编码规范.docJava程序编码规范.docJava程序编码规范.docJava程序编码规范.docJava程序编码规范.docJava程序编码规范.docJava程序编码规范.docJava程序编码规范.docJava程序编码规范.doc
Java 程序编码规范
详细地介绍了JAVA程序的编码规范,希望对大家有所帮助
java程序编码规范.txt
阿里 java 编程规范
该文档包括java开发中的注释规范,命名规范,属性名和方法名。还有命名原则
最新Java程序编码规范
第一个java程序扩展以及java编码规范和发展史
java的基本编码规范,让你的代码更加清晰可读
为使开发项目中所有的JAVA程序代码的风格保持一致,增加代码的可读性,便于维护及内部交流,使JAVA程序开发人员养成良好的编码习惯,有必要对JAVA程序的代码编码风格做统一的规范约束。本文档定义了我公司软件开发...
代码规范相当重要. 代码规范提高软件代码的可读性 , 使得开发人员快速和彻底的理解新代码. 好的代码风格不仅会提高可读性 ,而且会使代码更健壮 , 更为...本书为chm格式的,希望对大家学好java的编码规范有所帮助……
描述了java编写程序时需要注意的东西,使编码规范