编码实践五要诀
程序员文章站
2022-07-15 14:30:02
...
我们需要有快速、高水平的浏览编码实践和性能,这样我们就有更多的时间和精力去关注总体情况。我们要避免的是过度的关注一个特定的方面,从而避免遗留其他方面的漏洞。如何去做呢?这里有一个简短的列表(排名不分先后):
代码可读性
代码应该让人理解在该方法下发生了什么。
代码可访问性
人们应该能够猜出哪个类有“某某可重用组件”。
将一切都放在一个单独的类中可以使代码很容易,但是那是不好的方式。避免像CommonUtil、CommonServices这样的通用名称;
把代码分成多个文件,使用适当的名称让它们更容易找到。
代码复杂性
代码的复杂性应该匹配领域的复杂性。代码混乱是可以避免的,而一个领域适当水平的复杂性是不可避免的,例如对于像银行或CRM这类复杂的领域,代码就不能简单了。试图简化事情,一味的保持简单是有很大风险的。你的架构应该为最终完整版本而设计,不要计划着扩建“第二阶段”。
不要重复自己的编码
重复操作应该属于方法/通用类:
如果你复制粘贴代码超过5次,请把这种习惯转移到自己的方法/通用类。
性能
优先考虑优化的部分
最后
本文只是一个简短的评论,在这里面,如果你只想遵循两点的话,那么应该是以下这两点:
原文来自:DZone
代码可读性
代码应该让人理解在该方法下发生了什么。
- 对类、方法、变量等使用好的、有意义的命名方式;
- 特别是,局部变量应该有一个有用的名称;
- 使用流行通用的名称,比如i、j等,它们是受欢迎的,即便没有什么意义。
代码可访问性
人们应该能够猜出哪个类有“某某可重用组件”。
将一切都放在一个单独的类中可以使代码很容易,但是那是不好的方式。避免像CommonUtil、CommonServices这样的通用名称;
把代码分成多个文件,使用适当的名称让它们更容易找到。
代码复杂性
代码的复杂性应该匹配领域的复杂性。代码混乱是可以避免的,而一个领域适当水平的复杂性是不可避免的,例如对于像银行或CRM这类复杂的领域,代码就不能简单了。试图简化事情,一味的保持简单是有很大风险的。你的架构应该为最终完整版本而设计,不要计划着扩建“第二阶段”。
不要重复自己的编码
重复操作应该属于方法/通用类:
如果你复制粘贴代码超过5次,请把这种习惯转移到自己的方法/通用类。
性能
优先考虑优化的部分
- 不要这么做:无论哪个项目我都将优化我通常优化的部分;
- 将性能问题分类,并首先优化最关键的部分;
- 不要过度在意优化,代码的可读性和线程的安全比性能更重要。
最后
本文只是一个简短的评论,在这里面,如果你只想遵循两点的话,那么应该是以下这两点:
- 代码混乱是可以避免的,而一个领域的复杂性是不可避免的;
- 分类性能问题并首先优化至关重要的部分。
原文来自:DZone
上一篇: javascript DOM
下一篇: java coding 编码规范