编程

让代码更具可读性小技巧

402 2023-05-02 09:03:00

你是否维护过他人的项目?一个让你一打开就不寒而栗的项目?即使还未细读代码,你已经知道它一团糟了。

可能你也找不出具体问题,不过这些代码就是看起来就很怪异,感觉哪里不对。

编写整洁的代码;让你可以在写完一两年后回看还是能感觉修改起来很舒适的代码,是个艺术。这绝对是一个主观的话题——别误会我的意思;但“编写可读的PHP”有很多部分是可以掌握的。

首先我们要提的是,一个非常具有可操作性的小技校。请看这段代码:

public function getPage($url)
{
    $page = $this->pages()->where('slug', $url)->first();
    if (! $page) {
        return null;
    }
    if ($page['private'] && ! Auth::check()) {
        return null;
    }
    return $page;
}

就像文章一样,可以有效提高代码的可读性。可以称之为:给代码一些”喘息“的空间。示例

public function getPage($url)
{
    $page = $this->pages()->where('slug', $url)->first();

    if (! $page) {
        return null;
    }

    if ($page['private'] && ! Auth::check()) {
        return null;
    }

    return $page;
}

添加一些空行,将相关的代码进行分组,就能在很大程度上提高代码的可读性。

PHP