竹笋

首页 » 问答 » 环境 » 如何减少团队的低质量代码
TUhjnbcbe - 2024/4/10 17:04:00

说到代码质量,就不得不说各种屎山代码的段子了;

很多人知道阿里巴巴java开发手册;当中的规范对于大部分人来说较为晦涩难懂;其内容其实是对一本大受欢迎的书的精简和开发经验的总结;

这本书就是大名鼎鼎的整洁之道:

以下是对整洁之道的总结:

代码的作用

编译好让机器执行,完成功能需求

给自己或者队友看的,需要长期的维护和迭代

糟糕的代码

能跑就行

工期短、紧张高压下的产物

后期升级功能堆叠,无重构,越来越臃肿

整洁的代码

格式工整

易读,高质量代码读起来就像读英文文章一样顺畅

易维护,出现问题迅速定位,快速处理

cleancode的前提

对代码的理解,代码高比重是用来维护的

自我要求,我要写出高质量代码,对整洁代码的追求精神

cleancode

命名相关:

命名

命名规范(大小驼峰和命名是否合理)

函数命名:动词+名词结尾正例:getField

类名:名词或名词短语正例:FieldModel

接口:名词或者名词短语,形容词或者形容词短语

快捷键:点到变量名上点击shift+F6可修改变量名

2.单词拼写正确(大小写和单词正确拼写)

反例:main拼写成了mian;

反例:getByParam拼写成了getbyparam

3,有意义,不要担心过长,提高可读性;拒绝没有意义的命名,单字母,描述不清的短名

正例:getFieldModelByFieldApiName

反例:getModelBy

4.避免魔法值

5.命名不要太快,要舍得在命名上花时间

6.思考合理的命名,将节省未来阅读这段代码理解所需要的时间

7.命名是代码自描述的基础,优秀的命名将减少注释量,甚至不需要注释

8.0表示否,1表示是;不能出现多个字段的0和1含义混用

格式相关

格式缩进快捷键Ctrl+Alt+L(MAC电脑:

1
查看完整版本: 如何减少团队的低质量代码