《代码大全》中所讲的写代码的方式、风格是非常好的。如:
1.写程序前先写下伪代码,插入程序后,利用伪代码作注释
2.在重要的设计决策上写文档和注释,在一些算法优化上写注释,在必须写的地方写注释
3.还有很多、很多建议......
下面来分析一下实际中的优秀代码,着重给自己提个醒,What style is best and how to write comments!!!
从以上的代码中,可以得出Java编程风格建议是:
a.在package段上面放入一些声明性的文字(如:版权、其他说明信息)
b.接着是package段
c.package段下面是import段,建议尽量使用import java.util.Date的形式,这样可以避免一些潜在的冲突
d.紧接着是类的说明,描述类的基本用法
e.再下面是author、version和revise信息
f.下面是类成员的定义:
1)首先是类静态成员的定义:包括一些类变量、常量、静态方法、静态初始化器,最好将相同可见性的放到一块
2)接着是类的属性定义,最好将相同可见性的放到一块
3)接着是类的构造函数定义,最好将相同可见性的放到一块
4)接着是类的方法的定义,最好将相同可见性的放到一块
建议在每个段用“// ------------------------------------------------------- Class Attributes(Class Methods)”进行区分,这样可以使代码更易读
g.对于每个变量,给出一个简要的描述性的注释,如有必要给出一个详细的注释
如:此例中的dateFormatter变量
h.对于每个方法、静态初始化器、构造函数,给出一个简要或详细的注释;包括方法说明、参数说明、调用需要满足的条件、返回结果、是否有一些需要注意的问题(如:线程安全)、抛出异常、需要了解的其他类(see段)
i.在方法体内部对于一些重要的设计决定进行注释,如:上述类中getContextClassLoader()中的一段注释: