如何才能写出“高质量”的代码( 三 )


代码结构
代码行长度控制在100-120个字符可能用大多数为200行,最长500行的单个文件构造出色的系统关系密切的代码应该相互靠近变量声明应该靠近其使用位置若某个函数调用了另外一个,应该把他们放在一起,而且调用者应该放在被调用者上面自上向下展示函数调用依赖顺序
应该把解释条件意图的函数抽离出来,尽可能将条件表达为肯定形式不要继承常量,比如接口中定义常量,不要使用继承欺骗编程语言的作用范围规则模块不应了解它所操作对象的内部情况DTO(Data Transfer Objects)是一个只有公共变量没有函数的类对象暴露行为,隐藏数据不要使用“尤达表示法” 如 if(null == obj),现代编译器对if(obj = null)这样的代码会给出警告一般情况使用if else,简单语句使用三目运算符通常来讲提早返回可以减少嵌套并让代码整洁设计
类应该足够短小类应该满足单一权责原则(SRP),类和模块只有一个修改理由类应该只有少量的实体变量类应该遵循依赖倒置原则 DIP(Dependency Inversion Principle),类应该依赖于抽象而不是依赖于具体细节类中的方法越少越好,函数知道的变量越少越好,类拥有的实体变量越少越好
通过减少变量的数量和让他们尽量“轻量ji”来让代码更有可读性减少变量缩小变量的作用域只写一次的变量更好,如常量
最好读的代码就是没有代码从项目中消除不必要的功能,不要过度设计从新考虑需求,解决版本最简单的问题,只要能完成工作就行经常性地通读标准库的整个API,保持对他们的熟悉程度
简单设计运行所有测试不可重复表达了程序员的意图尽可能减少类和方法的数量以上规则按重要程度排列
无论是设计系统或者单独模块,别忘了使用大概可工作的最简单方案整洁的代码只提供一种而非多种做一件事的途径,他只有尽量少的依赖 。明确定义并提供尽量少的API减少重复代码,提高表达力,提早构建,简单抽象小结
作为代码整洁之道系列的diyi篇,本文从注释、命名、方法,单元测试,并发等视角简单给出了一些最佳实践,下文我们会展开来从每个方面介绍更多的实践事例 。相信每一个优秀的工程师都有一颗追求卓越代码的心,在代码整洁工程实践上你有哪些好的建议?数百人协作开发的代码如何保证代码整洁一致性?欢迎大家来讨论 。


特别声明:本站内容均来自网友提供或互联网,仅供参考,请勿用于商业和其他非法用途。如果侵犯了您的权益请与我们联系,我们将在24小时内删除。