编码技巧(一)命名

来源:互联网 发布:网络中介服务提供商 编辑:程序博客网 时间:2024/05/22 06:45

命名的重要性,不言而喻。一段好的代码,是不需要注释的。需要注释来进行说明的,往往是因为代码不能够清晰的表达出程序的意图。并且注释是需要维护的,系统在经历n代人的修修改改后,注释却依然保持着它最初的样子,这样的情况在一个历史悠久的系统中比比皆是,反而成了代码的坏味道。一言以蔽之,好的代码,拿到它的人能够轻松的通过命名看出字段的含义,方法做的事情,类的所属。那么,怎么写出好的命名呢?

  • 遵循约定
    通常人们习惯将数据库操作层命名为***Dao,业务逻辑层命名为***Service, 接口实现后面加上***Impl表明这是接口实现,工具类后面加个Util,这些都不应该轻易改变,除非你的小组内做了统一的约定。
  • 选用更清晰的命名方式
int timeOut;//超时时间,单位为秒int sleepTime;//睡眠时间,单位为秒int count;//航班数量统计final static String DB_NAME="flight_db";//数据库名

上面的例子,咋看之下没啥问题。但是下面的更好一些:

int timeOutInSec;int sleepTimeInSec;int countOfFlight;final static String DB_NAME_OF_FLIGHT="flight_db";
  • 拒绝模棱两可的命名
    这一点体现在代码维护上,如果可以清楚的知道字段,方法或类的含义,并且对它目前的命名感到不满,为什么不修改它呢?Idea可以很好的修改所有变量出现的地方。

暂时就想到这么多。。有啥想起了再补充。

0 0