《编写可读代码的艺术》第12章 把想法变成代码

    代码应当用“自然语言”编写

1. 清楚地描述逻辑

$is_admin = is_admin_request();
if ($document) {
    if (!$is_admin && ($document['username'] != $_SESSION['username'])) {
        return not_authorized();
    }
} else {
    if (!$is_admin) {
        return not_authorized();
    }
}
// continue rendering the page ...

//自然语言的描述
//1. 你是管理员
//2. 你拥有该文档
//否则，无法授权
if (is_admin_request()) {
    // authorized
} elseif ($document && ($document['username'] == $_SESSION['username'])) {
    // authorized
} else {
    return not_authorized();
}
// continue rendering the page ...

 

2. 了解函数库是有帮助的

// 功能：在网站中循环显示下一个提示
// 试想如果不用.next()库函数，代码肯定不会这么精简
var show_next_tip = function () {
    var cur_tip = $('.tip:visible').hide();
    var next_tip = cur_tip.next('.tip');
    if (next_tip.size() === 0) {
        next_tip = $('.tip:first');
    }
    next_tip.show();
};