a 先写注释后写代码
写代码注释的最好方法是在写代码之前就写注释。这使你在写代码之前可以想想代码的功能和运行。而且这样确保不会遗漏注释。另一种方法是边写代码边写注释。因为注释可以使代码更易理解,所以在程序开发的过程中,也可以利用这一点。如果打算花些时间写注释,那么至少你应从这个过程中获得些什么
b 在注释中加入HTML标记
在文档注释中加入HTML标记可使最后生成的技术文档的格式丰富而变得更有表现力,因此强烈推荐采用在文档注释中加入HTML标记的做法,具体做的时候可在任一有HTML编辑功能的编辑器(如FrontPage)中编辑后再将HTML源代码拷贝进源代码编辑器中。但是,由于Javadoc可在多种媒体中发布,可能会在一个不支持HTML的媒体上进行发布,因此在文档注释中加入HTML标记也会带来一些潜在的问题,但在当前环境中不会出现问题。
原理:在文档注释中加入HTML标记可使最后生成的技术文档的格式丰富,表达力强。
c 对每种类型的类写出一个模板
这些类型可能是:Applet,Application,Form等。这一个实践也可能由IDE环境直接提供,如JBuilder直接在New时会提示采用某种模板。
原理:因为不必每次都重写,而模板是遵循规范的,因此可以与规范更加符合。
d 多使用Object.equals()而不要使用“==”做值的比较
许多情况下的比较都可以同时允许使用Object.equals()和“==”并获得相同结果,但更多情况下是使用Object.equals()才能正常工作。
e J2EE应用中多使用System.out.print()将中间信息输出到控制台
将中间信息输出到控制台可以帮助编码人员了解系统的内部运作,方便调试,同时可以及时发现编码过程存在的隐藏问题。建议输出到控制台的信息主要包括:数据库SQL语句,中间变量。
f 尽量少用抽象类,而用接口取代;必要时可以抽象类和接口偕同使用
任何实现了接口的具体类都可以被当前对象调用;而当前对象到底调用的是哪个具体类完全可以动态的决定,这样一来就使系统的可插入性有了保证。