怎么样才能不写出别人嘴里的烂代码?

时间: 2019-07-21阅读: 67标签: 代码

每个人对于好的代码在自己不同的时期都有不一样的理解。当个人所在的层次变化,好代码的概念也会跟着变化。  


刚敲代码的时候

"老夫上手就是复制粘贴,别跟我说什么编码规范,设计模式"。刚入行的人一般都是接触到底层业务的开发,而且一般是比较浅显的业务需求。编码本身也有金字塔层级,最底端的人用于做着繁杂,混乱,变化莫测的业务需求。基本上今天写完明天改的那种。在这样的前提下,对于一个刚刚接触敲代码行业的新人而言,考虑编码规范,设计模式,几乎是不可能的。一切以按时完成任务为主要目的。


工作换了几次,改过几次别人的代码

"这写的什么玩意,简直是一坨翔,还不如自己重写"。写代码一定时间之后,自己的能力有所提升,接触到的东西越多,逐渐形成一套自己的感性认识。会一种感觉什么是好的代码,什么是不好的代码,但仅仅是感性层面的认识。

但是,每次当你辛苦重写完之前那套你认为是"一坨翔"的代码之后,你会发现,靠,跑不通了,不是这报错就是那报错。修修补补之后发现,自己重写的代码与重写自己自己的构想有很大出入。

又一段时间之后,终于代码稳定没啥爆bug的地方了,后面的人员看你的代码,还是想着,"这写的什么玩意,就是一坨翔"


在改别人的代码与被别人改代码挣扎多年

随着时间推移,发际线的上升,开始脑袋比较灵光了。看事情知道从不同的角度去看了,知道任何事情的存在必定有一定存在的因素。不再是 一 上来就把别人写的代码重写一遍,更多的是按一定的标准去重构。

重构跟重写是有很大区别的。重写是在了解代码逻辑之后,全部按自己的思路完全实现一遍。重构是修改代码中不符合规范,或不正确的地方,不合理的地方。

相对于重写而言,优秀的重构所需要的能力比重写要高很多。重写我不用管内外部依赖,反正都是推翻重新来过。而重构需要兼容整个项目,甚至是外部项目的依赖。


怎么样才能不写出一坨翔

说了这么多废话,其实我也不知道什么样的代码是好的代码,毕竟大家都说好的代码是不存在的。

只是说,尽可能的符合多数人的习惯,简洁不冗余的代码是稍微好的代码。

工作中整理了一些习惯,避免自己把代码写成一坨翔:


1)不要犯低级的语法错误,尽管不是ERROR级别的错误

这是最基本的,学习一门编程语言,不应该在对外项目代码中有语法错。语法错误只会让人家觉得你很low,是一个菜鸟。

例如定义常量,非静态方法不要使用静态方式调用

defiend(APP) or defien(APP,1);


2)检查用户输入数据

业务中有一条规矩,永远不要相信用户的输入数据。不能假设用户会按你需要的数据给你请求数据。

例如:

if($params['status'])
{

}

params 是用户请求参数,在判断取值之前,应该先判断是否有这个数据吧


3) 函数定义,默认参数应该放在末尾

例如下面的:

function makeSign($data,$header='',$clientip){

}


4)判断语句减少嵌套

function makeSign($data){

    if($data['status'] == 1)
    {
        if($data['client_id'] == 2)
        {
            if($data['type'] == 3)
            {
                //....业务逻辑2
                $status = 1;
            }
            else
            {
                //....业务逻辑1
                $status = 0;
            }
        }
        else
        {
            //....业务逻辑1
            $status = 0;
        }
    }
    else
    {
        //....业务逻辑1
        $status = 0;
    }
    return $status;
}

可修改为:

function makeSign($data){
    $data = array_merge(['status'=>0,'type'=>0,'client_id'=>0],$data);
    if($data['status']!=1 || !$data['type']!=1 || $data['client_id']!=1)
    {
        //....业务逻辑1
        return $status;
    }
    //....业务逻辑2
    return 1;
}

5)函数的输出尽可能同意,或者可以根据外部指定返回不同类型

function checkDataClient($clientId){
    if($clientId%2){
        return true;
    }
    return false;
}
function getdata($data){
    $data = array_merge(['client_id'=>0],$data);
    $res = $this->checkDataClient($data['client_id']);
    if( $res )
    {
        return $data;
    }
    return ['code'=>1,'msg'=>'非法用户'];
}

getdata方法,在client_id的数据非法的时候与合法的时候返回的数据格式不一致。

修改:

function getdata($data){
    $data = array_merge(['client_id'=>0],$data);
    $res = $this->checkDataClient($data['client_id']);
    if( $res )
    {
        return ['code'=>0,'msg'=>'','data'=>$data];
    }
    return ['code'=>1,'msg'=>'非法用户','data'=>[]];
}


6)类对象不要相互引用

时刻注意,构建的代码应该是一个层级的树状结构而不应该是网状结构。当代码变成网状结构的时候就是灾难爆发的时候,动任何一个地方都有可能引爆全部业务。相互引用也会造成内存的问题


7)编码规范化,最好是强制格式化指定的规范

规范不要靠嘴说!不要靠嘴说!不要靠嘴说!直接用工具格式化。任何语言都有业界比较好的规范,遵循规范,起码你代码看上去,阅读起来比较方便。


8)代码放置的位置要慎重

业务迭代的过程中,代码改来改去,今天加点,明天删点。但是代码的位置一定要思考清楚。

比如一个登陆验证:

function init(){
    if(!session('user_name'))
    {
        getUserNameFromDb(session('user_id'));
    }
    if(!session('user_id'))
    {
        throw new \Exception("请先登录", 1);
    }
    ...
}

这一看就是后期修改添加的代码,还放错位置了


可用工具

代码格式化可以用 phpcs。 代码的低级错误 可以用 phplint , phpstan 做代码静态检查。 代码设计层面,代码规范上,命名等可以使用 phpmd。

原文来自:写PHP的老王


链接: http://www.fly63.com/article/detial/4275

TypeScript 来做依赖注入的限制

依赖注入 是编写可测试/复用代码的关键。 在 TypeScript 中所有对象、属性和方法都有类型,可以大幅简化人工标注的代码,这让很多人重新考虑在 JavaScript 中实现依赖注入。 比如 Angular2 以后的 DI 实现

后端传过来一个JS代码,前端拿到之后执行

今天收到了一个需求,居然是后端给我传过来一个JS代码,然后前端去执行。因为后端传过来的JS代码是一个字符串,所以刚开始有点懵,以前也没有做过这样的东西所以刚开始没有方法。

Js代码中的span拼接

今天遇到一个小需求,用bootstrap的table只有两个字段,占用太宽,页面不美观,组长要求用拼接,一行几列的形式展现出来。我在form表单中拼接了span,遇到以下问题:

你不知道的 useCallback

对于新手来说,没写过几次死循环的代码都不好意思说自己用过 React Hooks。本文将以useCallback为切入点,谈谈几个 hook 的使用场景,以及性能优化的一些思考。

写业务代码最容易掉的8种坑

线程、线程同步、池、网络连接、网络链路、对象实例化、内存等方面的基础是最容易犯错的地方,搞清楚框架内部对于这些基础资源的的使用方式,根据最佳实践进行合理配置,这是业务开发时需要特别关注的点。

如何用不到200行代码写一款属于自己的JS类库

JavaScript 的核心是支持面向对象的,同时它也提供了强大灵活的 OOP 语言能力。本文将使用面向对象的方式,来教大家用原生js写出一个类似jQuery这样的类库。我们将会学到如下知识点

Js代码整洁之道

最近在做一些项目重构的工作,看了不少脏乱差的代码,身心疲惫。本文将讨论如何编写整洁的代码,不求高效运行,只求可读性强,便于维护。

什么样的代码叫好代码?

代码的本质还要在机器上运行,好的代码不单单的纯粹的简单的几个字符的问题,好的代码不仅仅是排版上或者语法上好看,还要能经过产品的测试验证,这是评判代码好坏的最准确的标准

程序员该如在低代码和无代码开发中抉择?

对于一个人第一次是如何了解低代码/无代码这两种开发方式,我总是充满好奇。这就是为什么我觉得贸易展会是如此有趣的原因;因为我可以拿同样的问题问每一个走进你的展台的人们。通常这是我问他们的第一个问题,当然是在扫描了他们的胸牌之后。

Clean Code之JavaScript代码示例

作为一个开发者,如果你关心代码质量,除了需要认真测试代码能否正确执行以外,还要注重代码的整洁(clean code)。一个专业的开发者会从将来自己或则他人方便维护的角度考虑如何写代码

fly63.com版权所有,内容以共享、参考、研究为目的,不存在任何商业目的。其版权属原作者所有,如有侵权,请与小编联系!情况属实本人将予以删除!

广告赞助文章投稿关于web前端网站点搜索站长推荐网站地图站长QQ:522607023

小程序专栏: 土味情话心理测试脑筋急转弯幽默笑话段子句子语录成语大全