《代码整洁之道》读书笔记(四)之格式篇

知识共享许可协议 版权声明:署名,允许他人基于本文进行创作,且必须基于与原先许可协议相同的许可协议分发本文 (Creative Commons

原文地址:https://liujiao111.github.io/2019/06/19/clean-code-fomat/

格式关乎沟通,代码格式很重要,必须严肃对待,因为你现在写的代码可能以后由其他人维护。

好的代码格式应该遵循以下规则:

应该保持良好的代码格式

选用一套代码格式规则,并贯彻这些规则。如果在团队中,每个成员都应该采用一套简单的格式规则

垂直格式

源代码文件应该有多大?类应该有多大?短文件通常比长文件易理解,尽量让类文件代码行在500以下。

向报纸学习

源文件要像报纸一样,短小而精悍。名称简单且一目了然。源文件最顶部给出高层次的概念和算法,细节从上往下渐次展开,直至找到源文件中最底层的函数和细节。

代码块之前的空格

关联性高的代码块应该与其他有一定的间隔,如隔一个空格行,这样逻辑更清晰,读起来更轻松。

代码之间的靠近

相互关联的代码应该放在一起形成一个代码块

关系密切的概念

关系密切的概念应该相互靠近

  • 变量声明:局部变量应尽可能靠近其使用位置,循环中的变量应该在循环中声明; 全局变量应该在类顶部声明
  • 调用函数:被调用的函数应该放在调用函数的下面第一位置。
  • 概念相关:概念类似的代码应该放在一起。例如几个名字很像,功能类似的方法。

横向格式

一行代码应该多宽?应该尽量保持代码行短小,尽量不要让代码超过右侧屏幕

空格分隔

空格字符把彼此紧密相关的事物连在一起,也把相关性较弱的事物分隔开。例如:

private void measureLine(String line) {
        lineCount++;
        int lineSize = line.length();
        totalChars += lineSize;
        lineWithHistogram.addLine(lineSize, lineCount);
    }

一方面,赋值语句两边是相对独立的,空格字符加强了分隔效果。另一方面,函数名和左元括号之间不加空格是因为函数名和参数紧密相关。

缩进

即便很短小的if/else/while等语句,也尽量遵循缩进而不是写在一行的原则。

附录:格式比较规范的代码典范:

在这里插入图片描述

在这里插入图片描述

电子书免费共享:链接:
https://pan.baidu.com/s/1wvoRJGonA70J9hFn_w5jwA
提取码: 37jy

猜你喜欢

转载自blog.csdn.net/qq_34464926/article/details/93193092