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

@method 的使用

/** 
 * @link http://manual.phpdoc.org/HTMLframesConverter/default/ 
 * 
 * @method static int search(string $query, $limit = 10, $offset = 0) 
 */ 
class SearchServiceProxy 
{ 
    public static function __callStatic($method, $arguments) 
    { 
        if (!method_exists("SearchService", $method)) { 
            throw new LogicException(__CLASS__ . "::" . $method . " not found"); 
        } 
 
        try { 
            $data = call_user_func_array(["SearchService", $method], $arguments); 
        } catch (Exception $e) { 
            error_log($e->getMessage()); 
            return false; 
        } 
 
        return $data; 
    } 
}  

@deprecated 使用 

class SearchService 
{ 
 
    /** 
     * @param string $query 
     * @param int    $limit 
     * @param int    $offset 
     * 
     * @return array 
     * @deprecated 
     */ 
    public static function search(string $query, $limit = 10, $offset = 0) 
    { 
        return [ 
            ["id" => 1, "aaa"], 
            ["id" => 2, "bbb"], 
        ]; 
    } 
}  

注释其他注意事项

注释解释张冠李戴，方法名更新，方法的功能业务注释没更新;复制别人的代码把 @author 信息也复制过来了，错误了还要把锅甩给别人。

注释更多参考 http://manual.phpdoc.org/HTML...

函数、方法

案例1

先说明一句，不好的代码不妨碍它成为一个优秀的软件。PHP MySQL 烂代码多的去了。

（编辑：南京站长网）

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