编写好代码的几个要素
来源:互联网 发布:JAVA年龄正则表达式 编辑:程序博客网 时间:2024/06/05 16:10
原文:http://www.techug.com/some-tips-for-good-code?ref=myread
清晰
虽然面向对象讲究内聚和封装,但是太多的子方法和类,实在是会把人绕到头晕,我推荐的做法是,方法尽量的内联,是同一个业务的就通通放到某个方法里面,如果这段逻辑实在太长,可以考虑抽取一些子方法(尽量别太多)。至于类,别动不动就来个类封装一把,要避免类膨胀。
好的命名和注释
现在网上的一些文章流行去除所有注释,通通用一个好的方法名字表达即可。这种做法我个人是很反对的。虽然方法的命名极其重要,但是写业务逻辑代码,必要的注释还是要的,另外的同事阅读代码的时候,也比较容易读懂代码的意图。
精准有意义的日志输出
如果从事过互联网项目的同学,应该有一种深深的体会,线上出现问题,除了看各种监控系统之外,就是看日志了。日志的输出必须是有意义准确的,尤其是 异常日志和业务日志。好的日志输出,可以快速定位问题并快速解决。如果解决一个问题要一个小时的话,有可能公司就损失几百万了。
代码对称性
例如:
getInputParameter(); process(); output();
这种就属于代码的对称性。
必要的设计
只是简单的根据业务场景直白的编写代码也是不可行的。必要的设计可以带来更加清晰的代码结构。
一定要有UT(单元测试)
没有UT的代码实在是太恐怖了,尤其是互联网应用的代码,稍微出点问题,公司就有可能损失一大笔钱。
编写ut的时候,至少一定要把重要的流程覆盖到,万一代码有问题了,也只是小问题。再者,由于需求的变更,原来写好的代码还需要再次改动,如果你没有ut覆盖的话,可能影响原来代码的功能。ut可以带给我们信心。另外UT也可以促进你编写清晰的代码。
0 0
- 编写好代码的几个要素
- 编写测试用例的几个要素
- 写好代码的五个要素
- 写好代码的五个要素
- 代码编写的几个原则
- programming的几个要素
- 如何编写“好”的代码
- 如何编写“好”的代码
- 如何编写好的代码
- 如何编写好的代码?
- 几个好的exploit代码站点
- 几个比较好的代码托管地址
- 网站运营的几个要素
- 编写好代码的10条戒律
- 编写好代码的10条戒律
- 编写好代码的10条戒律
- 编写好代码的10条戒律
- 编写好代码的10条戒律
- epel 下载地址
- 华为路由器 端口映射与防火墙
- 字符集编码浅谈:Unicode、UTF-8
- Android 动画应用完全解析(一)
- IOS键盘遮盖问题解决办法
- 编写好代码的几个要素
- 进程通信概述
- 【Zanuck 镇】编写php高性能snowflake算法插件(分布式64位唯一性自增id生成算法)
- 删数问题
- apache的DBUtil框架学习
- ContentProvide之手机联系人
- poj 3685(二分查找第K大的值)
- Leetcode 389 Find the Difference
- ADF 如何让给VO添加临时字段