1.注释
(1)不恰当的信息
注释应该只描述有关代码和设计的技术性信息,不应该添加无用的修改历史记录等信息。
(2)废弃的注释
过时、无关、不正确的注释就是废弃的注释。
(3)冗余注释
如果注释描述的是某种充分自我描述了的东西,那么注释就是多余的。注释应该谈及代码自身没提到的东西。
(4)注释掉的代码
看到注释掉的代码,就删除它。如果有人需要,可以签出以前的代码,别被它搞到死去活来。
2.函数
(1)过多的参数
函数的参数应该尽量少。
(2)标识参数
布尔值参数大声宣告函数做了不止一件事,它们令人迷惑。
(3)死函数
永不调用的方法应该丢弃,保留死代码纯属浪费。
3.一般性问题
(1)重复
重复代码遗漏了抽象,重复的代码可以成为子程序或者干脆是另一个类。
(2)在错误的抽象层级上的代码
所有较低层级概念放在派生类中,所有较高层概念放在基类中。
(3)垂直分隔
变量和函数应该放在靠近被使用的地方定义。
(4)前后不一致
如果将某个函数中用名为reponse的变量来持有HttpServletRepose对象,则在其他用到这个对象的函数中也用同样的reponse变量名。
(5)不恰当的静态方法
静态方法没机会用到多态特征,如果希望函数是多态的,就不应该是静态的。
(6)用命名常量替代魔术数
(7)掩蔽时序耦合
对于需要执行时序的函数,每个函数都应该产出下一个函数所需的结果,这样就没理由不按顺序调用了。
(8)避免浏览传递
遵循得墨忒耳律
4.Java
(1)不要集成常量
应该import进去
网友评论