代码阅读的目的:
- 基础方面:加强熟悉语法,代码风格,习惯等方面
- 自身经验浅薄,实践少。弥补认知方面的不足
- 学习代码在实践中的技巧等
- 浅层次方面:见识真实、复杂的代码是如何布局的,沟通,发展的。认识复杂的数据结构,算法,及其精妙之处。
- 深入方面:从架构,设计的方面去理解、认识代码。由浅入深,不断积累而窥见全貌。
代码阅读笔记的目的:
-
有些仓库不存在代码注释
-
存在代码注释,但是描述的层级较高。具体内部实现的,需要自己注释(除非代码专门有一本书描写)。
-
场景:工作中或是现实,往往已经有完善的代码环境,设施。读代码的占比 远大于 写代码。
- 业务代码的阅读方式与基础库代码的阅读方式,有时是差别很大的。笔记的方式也会不同
-
演化:
- 从具体细节,变化为 主线要点
-
不必要性:复杂的
redis原因:
为什么需要代码阅读记录?1、因为人与代码仓库、代码作者之间的认知经验差异,导致无法理解代码、注释等。2、代码本身的注释的问题(缺少、错误、不够详尽)3、扩展补充、测试记录、实践发现等内容
- 现象01:有时候自身基础不足,对于代码的注释越看越无法理解,这是代码语言与自然语言不合的体现。
阅读的策略:
- 1、自下而上
- 2、自上而下
阅读的个人经验:
- 1、代码阅读是“量变产生质变”的最令自己感受深刻的地方,自一门生疏的语言到渐渐熟悉,积累的个人实践方法与经验。
更多笔记的规范: (@see 《tmpNoteSpecific.md》)
【🤢🤢🤢】
【🤢:exception】
❌
对于一些实际的项目,会很复杂。程序的内部跳转,关联给人一种错综复杂的感觉。代码本身有着一套自己未曾见过的框架结构,建立在这种框架结构之上的一套复杂的业务,业务本身是一种分布式的复杂逻辑,在关键的、复杂的数据结构背后,又包含着一批不重要的。
对于不熟悉的人来说,会感觉无从下手,难于确定入口。
代码阅读笔记的记录困难:
超多层的层级结构链,内容量很大,这样的内容记录在文本中。有很多缺点:
1、记录困难,排布组织不方便。
2、阅读困难,量太大。