其他分享
首页 > 其他分享> > 代码整洁之道要点(二)

代码整洁之道要点(二)

作者:互联网

本系列出自于本人看过《代码整洁之道》后总结的一部分要点。 非常感谢这本书给我和广大程序员带来的快乐!
注: 需要该书电子版的朋友请私信我。
推荐歌曲:Try - Marlisa

注释不能美化糟糕的代码
带有少量注释的整洁而有表达力的代码,要比带有大量注释的零碎而复杂的代码像样得多。
与其花时间编写注释解释糟糕的代码,不如花时间清洁那堆糟糕的代码。

好注释
注释也有好的,比如:法律信息、提供信息的注释、对意图的解释、阐释、警示、TODO注释、放大、公共API等。

坏注释
什么是坏注释呢?坏注释就是糟糕的代码的支撑或者借口,或者对错误决策的修正。
比如:喃喃自语、头部多余的注释、误导性注释、循规式注释、日志式注释、废话注释、归属与署名、注释掉的代码。

概念间垂直方向上的区隔
每行代码展示一个表达式或者一个字句,每组代码行展示一条完整的思路,在每组代码之间用空白行区隔,这样能极大地影响到代码的视觉外观。
每个空白行都是一条线索,标识出新的独立概念。

垂直顺序
一般而言,我们想自上而下展示函数调用依赖顺序。也就是说,被调用的函数应该放在执行调用的函数下面。

横向格式
一行代码的宽度不应太宽,尽管如今显示器越来越宽。
代码的宽度最好保持在120个字符以内。

水平方向上的区域与靠近
我们在赋值操作符周围加上空格字符,在相关性较弱的事物间加上空格,能进一步强调分割效果。
乘法因子之间没加空格,因为它们具有较高优先级。加减法运算项之间用空格隔开,因为加法和减法优先级较低。

数据抽象
隐藏实现并非只是在变量之间放上一个函数层那么简单。隐藏实现关乎抽象!
类并不简单地用取值器和赋值器将其变量推向外部,而是暴露抽象接口,以便用户了解数据的实现就能操作数据的本体。

数据、对象的反对称性
过程式代码便于在不改动既有数据结构的前提下添加新函数。
面向对象代码便于在不修改既有函数的前提下添加新类。

标签:空格,函数,代码,之道,注释,要点,糟糕,整洁
来源: https://blog.csdn.net/weixin_44737486/article/details/122721430