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

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

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


刚敲代码的时候

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


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

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

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

又一段时间之后,终于代码稳定没啥爆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的老王


吐血推荐

1.站长广告联盟: 整理了目前主流的广告联盟平台,如果你有流量,可以作为参考选择适合你的平台点击进入...

2.休闲娱乐: 直播/交友    优惠券领取   网页游戏   H5游戏

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

如何阅读别人的代码?

比起阅读代码,我更喜欢看别人的文章或者书。我喜欢他们跟我面对面的交流,用简单的自然语言或者画图解释他们的思想。有了思想,我自然知道如何把它变成代码,而且是优雅的代码

把同事的代码重写得干净又整洁,老板却让我做回滚?

我的同事把这周写的代码提交了。我们在开发一个图形编辑器画布,已经实现了形状调整功能,即通过拖拽形状边缘的手柄来调整形状(比如矩形和椭圆形)。代码可以运行。

掌握依赖注入5大原则,无需额外编代码!

如果是第一次接触这个概念,可能会一时没有头绪,网上的各种解释可能会让你更加混乱,并觉得它没那么简单。 其实依赖注入本身是单纯、简单的。简单来说,依赖注入是一种方式、方法或者说手段

如何在 React 中优雅的写 CSS?

如果是 ui 组件库中使用建议使用 namespaces 方案,ui 组件库维护人员基本固定,遵守约定的规范较为容易,可通过约定规范来解决不同组件 CSS 相互影响问题,由于 ui 组件库会应用于整个公司的产品

让代码具有可读性的10种最佳实践

如果咱们关注代码本身结构及可读笥,而不是只关心它是否能工作,那么咱们写代码是有一定的水准。专业开发人员将为未来的自己和“其他人”编写代码,而不仅仅只编写能应付当前工作的代码。

如何执行innerHtml中的script代码?

有时候我们会有把一整段 HTML 动态塞进页面的需求,例如渲染了一个模板,从服务器端获取了一段广告代码等。一般情况下我们使用 container.innerHTML 即可

编写可维护的Js代码

不省略分号(在原生及使用工具函数的情况不建议省略,在使用比较完善的框架如vue或者自己配置好 webpack 时可以省略),1行代码长度不超过80个字符(个人比较推荐,毕竟编辑器的自动换行有时真的很难受)

200行代码实现超轻量级编译器

本篇和大家一起学习写一款超级简单轻量,去掉注释只有不到200行代码的编译器。,该编译器将类 lisp 语法函数调用 编译为 类C语言函数调用

什么才是优秀的代码?

究竟什么是优秀的代码?Robert Martin的一句话可以完美诠释。代码质量的唯一衡量标准是每分钟说多少次WTF,我来解释一下这句话。当我在做code review时,通常会有三种不同的感受:

好代码的用处,怎么写出好代码?

实际上本书建立在一个相当不可靠的前提之上:好的代码是有意义的。我见过太多丑陋的代码给他们的主人赚着大把钞票,所以在我看来,软件要取得商业成功或者广泛使用

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

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

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