1,规范与约定
命名:
无论是变量、函数、类,命名都应让人一看便明白其意义,把信息装到名字里,不可取让人误解的名字,尽量用程序专业单词。
注释:
注释应简短,尽量不在函数体里注释,取个好名字胜于任何注释,如果代码需要注释才能让人明白,应该考虑下重构了。
可读性:
保持整个项目代码风格一致。
避免复杂、过长的逻辑表达式。
避免深层嵌套。
避免太长的函数体。
简结:
代码简单、整洁,才是优秀的代码。
复用:
多考虑代码的复用性,高内聚、低偶合,少用全局变量。
2,团队合作
代码提交:
绝不要提交尚未完成的代码,要明白这不是你一个人在战斗。
提交连编译都未通过的代码,这是在犯罪。
不要一次提交过多代码,如果任务太大,可拆分成小任务。
完成的功能代码应即时提交。
提交前最好能测试完善,例如单元测试。
提交代码应有注释日志。
版本控制:
保持主干一直开发,分支应是功能完善,经过测试没明显bug的。
代码复查:
代码复查是无价之宝,是移除缺陷、排除bug的最佳方法。
通过不断的复查,重构才能保持代码的健壮。
立会:
每天开10-20分钟的站立会议。简单总结下昨天的工作,今天的安排,还有遇到的问题。
3,测试反馈
单元测试:
听说单元测试检查和验证代码正确性的最佳方法,甚至有先写单元测试再写实现的说法。
目前很多语言都有成熟的单元测试框架。
即时反馈:
完成的功能应即时测试,即时反馈
4,代码重构
重构(名词):对软件内部结构的一种调整,目的是在不改变软件可观察行为的前提下,提高其可理解性,降低其修改成本。
重构(动词):使用一系列重构手法,在不改变软件可观察行为的前提下,调整其结构。
重构可改进软件设计;使软件更容易理解;还可以帮助找到bug。重构还可提高程序可维护性,使程序更容易扩展,从而提高编程速度。
那么应何时重构怩?事不过三,三则重构。添加功能时重构,修补错误时重构,复审代码时重构。
永远记住重构的前提是不改变可观察行为。重构应小步进行,保证不破坏原来的功能行为,应有充分的测试。
5,优秀代码之道
保持简单
高内聚、低偶合
少用全局变量
一次只做一件事
可复用、可扩展、可修改、灵活性强
重构,改善既有代码的设计