《代码阅读方法》---笔记（第七章）

第七章：编码规范和约定

关于代码规范建议去阅读阿里出品的泰山版《Java开发手册》
https://developer.aliyun.com/topic/java2020?utm_content=g_1000113321

1.格式规范

1. 阅读代码时，首先要确保您的编辑器或优美打印程序的tab设置，与代码遵循的风格规范一致。
2. 可以使用代码块的缩进，快速地掌握代码的总体结构。
3. 对于编排不一致的代码，应该立即给予足够的警惕。

2.命名规范

1. 常量使用大写字母命名，单词用下划线分隔。
2. 在遵循Java格式的程序中，包名(package name)总是从一个顶级的域名开始(例如，org，com，sun），类名和接口名由大写字母开始，方法和变量名 由小写字母开始。
3. 用户界面控件名称之前的匈牙利记法的前缀类型标记可以帮助我们确定它的作用。

3.代码审查

1. 分析代码时，对标记为XXX，FIXME和TODO的代码序列要格外注意：错误可能就潜伏在其中。
2. 在审查代码的可移植性，或以某种给定的编码规范作为指南时，要注意了解规范的对可移植性需求的界定与限制。
3. 如果GUI功能都使用相应的编程结构来实现，则通过代码审查可以轻易地确定用户界面的规格说明是否被正确地采用。

4.其他

1. 了解了给定代码库所遵循的文件组织方式后，就能更有效率地浏览它的源代码。
2. 不同的编程规范对可移植构造的构成有不同的主张。
3. 了解项目编译过程的组织方式与自动化方式之后，我们就能够快速地阅读与理解对应的编译规则。
4. 当检查系统的发布过程时，常常可以将相应发行格式的需求作为基准。

参考：
https://blog.csdn.net/weixin_42561498/article/details/87378105