知识卡片

普通读书笔记卡 · 2308.a.1

注释是提炼函数的信号

理解等级:初级

(代码坏味道的三层划分见旧卡。)

过长方法的形成:任何超过 10 行的方法都可以考虑是否过长,原则上不超过 100 行。创建新方法的难度通常大于往已有方法里加功能——“就加两行,为此新建方法小题大做”;于是张三、李四、王五各加两行,方法日益庞大,最终无人能完全看懂,大家更不敢动它,只能恶性循环地往里加。看到超过 200 行的方法,通常是多个程序员东拼西凑出来的。

找注释:加注释通常因为逻辑晦涩复杂、或这段代码功能相对独立或特殊处理。代码前方有一行注释,就是在提醒你:可以把这段代码替换成一个函数,并以注释为基础给函数命名。方法有描述恰当的名字,就不必查看内部实现。即使只有一行代码,如果需要注释说明,也值得提炼到独立函数中。

其他方法级坏味道:参数太多、超长或超短标识符、数据过量返回、超长代码行(一行里链式调用、嵌套构造参数和数学表达式)。

用法:重构长方法时,先把每一段“带注释的块”提炼成以注释命名的函数,原方法就会变成一串可读的步骤调用——这是最机械、风险最低的第一步。

这张卡片看不懂?

已有反馈 · 0 条

    还没有人提交反馈。

    在整书笔记中的位置

    原书出处 · 1 处

    • · 查看原书依据

      如果代码前方有一行注释,这就是在提醒你:可以将这段代码替换成一个函数,而且可以在注释的基础上给这个函数命名。

    参考来源

    - 位置:《软件架构理论与实践》第20章《第20章 软件架构坏味道》20.2.3 方法级坏味道(源文件:extracted/软件架构理论与实践/_epub-src/OEBPS/text00170.html,来源项目 book-sources) - 结论依据:第20章分析过长方法的成因:新建方法比往已有方法加两行更麻烦,多人累加导致无人敢动的恶性循环,超过200行的方法通常是拼凑而成;技巧是寻找注释,把带注释的代码段提炼为以注释命名的函数,哪怕只有一行。 - 原始内容:如果代码前方有一行注释,这就是在提醒你:可以将这段代码替换成一个函数,而且可以在注释的基础上给这个函数命名。