如何成为一名优秀的工程师（语义篇）

好的语义表达是团队协作中高效迭代的润滑剂，好的语义表达是线上未知代码问题排查的指南针。

本篇文章巨长，如果你比较“懒”，来我讲给你听(直播中有更多细节) 回放地址

看完这个还不过瘾?学习使你快乐?还想学习?快上车

不要让其他人读不懂你的代码，其他人可能就是一周后的你。时刻以“如果你写的这段代码出现故障，一个陌生人接手你的代码需要多久能处理完这个bug”来监督自己。

日常中应该多多刻意提升自己语义表达，百利而无一害。那么我们应该从哪些细节去做好语义表达呢? 

以下代码全为我的艺术创作，不属于任何实际项目

命名

案例1

function getGoods($query, $shopId) 
{ 
    $goodsId = Goods::add($query["uid"], $query["name"]); 
    return Shop::add($goodsId, $shopId); 
} 
 
class Goods 
{ 
    public static function add($uid, $name) 
    { 
        $id = mt_rand(1, 100000); 
        return $id; 
    } 
} 
 
class Shop 
{ 
    public static function add($goodsId, $shopId) 
    { 
        $id = mt_rand(1, 100000); 
        return $id; 
    } 
}  

案例2

function getUserInfo($teamId, $youId = []) 
{  
}  

如果仅仅有这个函数名和参数名，谁能猜到参数的意义呢?

案例3

class Db 
{ 
    /** 
     * @param string $table 数据库表名 
     * @param array  $data  新增数据 
     * 
     * @return int 新增主键 
     */ 
    public static function insert(string $table, array $data) 
    { 
        $id = mt_rand(1, 1000); 
        return $id; 
    } 
} 
 
class ViewLogStore 
{ 
    private $table = "view_log"; 
 
    function setHistory($data) 
    { 
        Db::insert($this->table, $data); 
    } 
}  

案例4

假如业务代码里有这些类

class WechatUserModel{ 
} 
class WechatGroupModel{ 
} 
class WechatMessageModel{ 
}  

（编辑：宣城站长网）

【声明】本站内容均来自网络，其相关言论仅代表作者个人观点，不代表本站立场。若无意侵犯到您的权利，请及时与联系站长删除相关内容!