软件构造笔记-布局技术
程序员文章站
2022-03-10 14:14:37
...
csdn上面的第一篇博文,新的开始。
布局技术
- 空白
- 括号
空白是指空格、缩进等。
布局结构
- 纯块结构
- 模仿纯块结构
- 行尾对齐
单条语句的布局
语句长度
应该控制在80个字符之内。
原因:
- 超过80个字符难以阅读。
- 80个字符不鼓励深度嵌套。
- 抑易于小屏幕打印。
空格使语句更清楚
- 使用空格让逻辑表达更容易接受。
- 使用空格让数组引用更容易阅读。
- 使用空格让程序参数更容易阅读。
格式化后续行
-
使后续行明显。
把符号放在后面,可以提示阅读者此行未完,但不如前面整齐。
从清晰度角度来说放在前面更清晰。 -
将子程序调用的后续行按标准缩进。
-
让后续行的结尾易于发现。
把结尾括号单独一行可以标记结尾,易于发现。 -
控制语句后续行缩进标准空格数。
易于缩进 -
不要将赋值语句按等号对齐。
等号对齐,更加清晰,很舒服(我不管我就要这么布局!)
int aaaaaa = a();
char bb = b();
boolean sssssss = s();
非等号对齐,经得起改进。(黄武先生推荐,但是我还是喜欢上面的布局)
int aaaaaa = a();
char bb = b();
boolean sssssss = s();
- 不要让一行有多个操作。
下面的操作就会造成问题。使用第二种操作就十分清晰。
// op 1
function(n++, n + 2);
// op2
n++;
function(n, n + 2);
注重工程化,不要写“聪明”程序,注重可读性。
数据声明布局
- 每行只声明一个数据。
注释缩进要与相应代码一致
类接口布局
- 说明类及其完整用法的头部注释
- 构造和析构
文件和程序布局
- 一个文件应只有一个类
- 文件命名应该与类名有关
上一篇: 软件构造之策略设计模式
下一篇: TCP连接状态异常记录