编码技巧(一)命名
来源:互联网 发布:网络中介服务提供商 编辑:程序博客网 时间: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
- 编码技巧(一)命名
- Android开发编码规范之文件命名(一)
- Xcode提高编码效率小技巧(一)
- 阿里java编码规范(一)命名风格,常量定义,和代码格式
- (一)命名风格
- 命名规范(一)
- 编码规范(二)之命名规范
- 命名规范,编码规则(Android版)
- (4.6.18)Android编码命名规范
- C#命名规范(一)
- 命名空间 xml(一)
- Hibernate编码技巧一--类似查询归一
- JavaScript技巧续(命名规范)
- 安全编码(一)
- iOS编码(一)
- 编码规范 (一)
- java 编码(一)
- 编码风格(一)
- Node.js作为服务器的文件上传
- 贪心算法之最优装载
- 【java】Java 中父类怎么调用子类的方法?
- KMP模板
- python _、__和__xx__的区别
- 编码技巧(一)命名
- linux安装JDK遇到的几个低级问题
- [51nod 1139]奇妙等式的解
- 贪心算法之单源最短路径Dijkstra
- 双网卡
- CXF 连接超时与请求超时的设置
- 228. Summary Ranges
- 利用余弦计算文本相似性
- Spring学习04--注入、依赖、方法注入详解