clean code笔记4:格式

格式规范

 好的代码格式,意味着代码的整洁和对细节的关注。
  • 如果是在团队中工作,则团队应该一致同意采用一套简单的格式规则,所有成员都要遵守,并且贯彻。使用能帮助你应用这些格式规则的自动化工具也很有帮助。

格式的目的

  • 先要明确一下,代码格式很重要。因为格式关乎沟通,而沟通是专业开发者的头等大事。
  • 或许你认为让代码能工作才是专业开发者的头等大事。但是实际上,修改和维护代码才是开发者花时间花得最多的地方。只有拥有良好的代码格式,代码的可读性才会增加,这对日后修改和维护产生深远影响。

垂直格式

  1. 像报纸学习。源文件要像报纸文章一样,名称如同标题一样,简单且一目了然。源文件最顶部应该给出高层次概念和算法,细节应该往下渐次展开。
  2. 在不同的思路之间的代码以空白号为分隔。因为每个空白行都是一条线索,标识出新的独立概念,往下读代码时你的目光,总会停留在空白行之后那一行,而且这样是代码,思路更清晰更易懂。
  3. 靠近的代码行则暗示了他们之间的紧密关系,紧密相关的代码应该相互靠近。

垂直距离

  • 变量声明尽可能靠近其使用位置。
  • 关系密切的概念,不要放到不同文件中。
  • 概念相关的代码应该放到一起,相关性越强,彼此之间的距离就该越短。
  • 循环中的控制变量(for(int i...)),应该总是在循环语句中声明。
  • 类的属性变量应该全部在类的顶部声明,而不是东一个西一个,使人很难找到。
  • 若某个函数调用另一个,就应当把他们放在一起。

垂直顺序

  • 最上面的代码应该是最抽象的,底部细节应该在下面实现。这样就能像报纸文章一样,最重要的概念在最前面,底部细节最后才会出来。

横向格式

一行的上限是120个字符。短代码行,利于理解,所以应该尽力保持代码行短小(在30个字符以内)
  1. 水平方向上的区隔与靠近。在赋值操作符周围加上空格字符达到强调目的(a = 2而不是a=2)。
  2. 水平对齐。不需要无意义的水平对齐,比如在那类里面声明属性的时候,那些无意义的水平对齐会在强调不重要的东西,会把读者的目光从真正的意义上拉开。

缩进

if,while,函数后面都应该加上缩进。违反缩进规则的代码,通常可读性极差。

团队规则

每个程序员都要自己喜欢的格式规则,但如果在一个团队中工作,就必须是团队说了算。
  • 一组开发者应当认同一种格式风格,启动项目之前制定一套编码风格,所花时间很短,却能为为以后阅读他人代码、团队合作提供了巨大的便捷,并且整个软件系统是由一系列读起来的不错的,代码风格统一的代码文件组成。绝对不要用各种不同的风格来编写源代码,这样会增加其复杂度。
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
平台声明:文章内容(如有图片或视频亦包括在内)由作者上传并发布,文章内容仅代表作者本人观点,简书系信息发布平台,仅提供信息存储服务。

推荐阅读更多精彩内容

  • _注:正文中的引用是直接引用作者Bob大叔的话,两条横线中间的段落的是我自己的观点,其他大约都可以算是笔记了。 _...
    TheAlchemist阅读 1,315评论 9 11
  • Android 自定义View的各种姿势1 Activity的显示之ViewRootImpl详解 Activity...
    passiontim阅读 172,866评论 25 708
  • 外貌对一个人来说是否重要?不知道,但就我自身而言,当我判断一个陌生人时挺看重,观察对方的五官,穿着,形体气质最后是...
    fish人鱼朵朵阅读 261评论 0 1
  • 7:20分,闹钟响了。关掉闹钟,打开音乐播放器,起床。 美好的一天开始了。 伴随着喜欢的旋律,刷牙洗脸。换下睡衣,...
    阿拉小姐阅读 252评论 0 0
  • 许小小将钥匙插进门里转了两圈,进了门将书包往沙发上一扔,索性客厅的灯也懒得开,踩着拖鞋就回自己房间了。要说新学期的...
    小楼今夜可东风阅读 488评论 0 0