如何阅读别人的代码

Posted 2021-03-08 andy0816

##############################################

 

"""

阅读什么样的代码？
很难明确的说应该阅读什么样的代码，只能说有一些基本的原则：

1，阅读那些你用得着的代码
这一步最好从阅读那些你已经在使用的插件或者库文件开始。
这些都是你可以学习的非常好的例子。你已熟悉了它们的公共API，了解它们内部工作原理的障碍是较低的。
此外，作为代码的用户，你有机会添加文档、实现新的功能，或者通常以某种方式给项目做贡献。

2，阅读那些你印象深刻的代码
你最近对什么项目印象深刻?是开源的吗?如果是这样的话，这是一个很好的阅读选择，因为代码很可能会给你留下深刻的印象。

3，阅读那些让你尊敬的大师写出来的代码

4，阅读那些能给你带来灵感的代码
选择小项目的代码，除非除非你是一个有经验的而且已经很会阅读别人代码的开发者了。
大型项目有更多的活动部件，你可能最终会因为这些概念而陷入困境，无法学到任何有价值的东西。
困惑会导致沮丧，而更大的项目更有可能让你在阅读中感到困惑和气馁。
选择一个小项目阅读的好处是可以一次将整个程序逻辑放在脑子里。这样你就可以关注细节，从而学习到很多知识。


"""

 

#############################################

"""

如何阅读别人的代码？
既然你已经选择了一些代码来阅读，那么最好的阅读方式是什么呢?下面提供一些方法来最大化你的投资回报率，也就是读的少，但是收获多。

1，先看大框架
假设你至少在宏观层面上知道你所读的代码是如何实现的。
如果没有，先阅读项目的网站、教程、文档，以及除了代码之外你可以掌握的其他任何东西。
第一步就是先大致浏览一下项目的架构。
这一步的目标是熟悉源代码。找出哪些文件包含/请求/加载其他文件，其中大部分代码在哪里，如果有的话，使用的命名空间是什么，以及这些性质。
一旦你掌握了大局，你就可以深入挖掘细节了。

2，记录阅读心得
阅读代码不应该是一种被动的行为。当你开始理解程序流时，我鼓励你在开始时添加注释，记录你的假设和结论。当你第一次开始的时候，你的记录大概会是这样的:
随着你的理解进展，你可以删除你当时留下的无关紧要的一些评论，也许还可以写一些有意义的、权威的评论，这些评论可能会被提交给你的项目。

3，边阅读边测试
当你阅读别人的代码时，测试是一个很好的起点，因为他们记录了代码应该完成的任务。

4，亲自动手做
谁说阅读代码时双手就得闲着?只有当你把所有的东西都打乱了，然后自己试着重新拼装好时，才能在这个过程中真正理解。
还记得那些通过的测试吗?想办法让它们失败，添加更多，或者尝试更改实现的逻辑而不破坏它们。
尝试添加一个你认为很酷的小功能，或者设置项目范围的日志记录，这样就可以在代码的不同阶段打印输出。

5，清除再重复
一旦读完了一个代码库，再选一个，然后重新开始这个过程。代码读的越多，你就能从阅读中获取更好的信息，你花的时间就越少。
我认为你会发现投资回报增长很快，而且这是一种非常有趣的学习方式。
"""

 

#############################################

 

 

#############################################