image.png

31.1 基本原则

一、好布局有什么用

image.png

二、把布局作为一种信仰

image.png

三、良好布局的目标

1. 准确表现代码的逻辑结构

好的代码主要是为了展现代码的逻辑结构。典型的例子就是，程序员利用缩进等空白来表达依赖关系

2. 始终如一地表现代码的逻辑结构

有些布局风格的规则会遇到许多例外，以至很难一直遵守。好的代码风格能够适应大多数情况。

3. 改善可读性

4. 经得起修改

理想的布局方案应该能经得起代码修改的考验。修改某行时不必连带修改其他行的代码。

31.2 布局技术

一、空白

image.png

二、括号

image.png

31.3 布局风格

一、纯块结构

1. if 块的结构

  1. if(name) {
  2.     // ToDo 
  3. }

2. while 块的结构

  1. while(name) {
  2.      // ToDo 
  3. }

3. switch 块

  1. switch (key) {
  2.   case value:
  3.         // ToDO
  4.     break;
  5.   default:
  6.     break;
  7. }

二、行尾布局

image.png

31.4 控制结构的布局

一、格式化控制结构块的要点

image.png

二、其他考虑

1. 段落之间要使用空行

image.png

2. 单语句代码块的格式要前后统一

单语句代码块就是控制结构后面只有一条语句，比如 if 语句后仅有一条语句时。

3. 对于复杂的表达式，将条件分隔放在几行上

image.png

31.5 单条语句的布局

一、用空格使语句显得清楚

image.png

二、格式化后续行

image.png

三、每行仅写一条语句

image.png

四、数据声明的布局

1. 每行只声明一个数据

image.png

2. 变量声明应尽量接近其首次使用的位置

3. 合理组织声明顺序

image.png

31.6 注释的布局

1. 注释的缩进要与相应代码一致

  1. /**
  2.  * ToDo
  3.  */
  5. // ToDo

2. 每行注释用至少一个空行分开

image.png

31.7 子程序的布局

1. 用空行分隔子程序的各部分

image.png

2. 将子程序参数按标准缩进

image.png

31.8 类的布局

1. 类接口的布局

image.png

2. 类实现的布局

image.png

3. 文件和程序布局

  1. 一个文件应该只有一个类
  2. 文件的命名应与类名有关
  3. 在文件中清晰地分隔各子程序
  4. 按字母顺序排列子程序

    要点

    image.png

    脑图

    image.png
    https://www.processon.com/view/link/60974343e0b34d254cebcdf9