如何阅读github上的代码？

Question

有些项目在readme中写明了每个文件是用来干什么的，有的则没有。面对这种情况改如何查看别人的代码？
只能每个文件都去看一遍还是github文件命名有规范，了解命名规范后进行查找？比如我知道docs一般用于存放文档 。看文档直接去docs文件下去找

Answer 1

来哥哥教你三句成语

1. 望文生义 //即通过公认的命名规范和自己的经验来揣摩作者的意图， e.g. db文件夹下面99%放的是数据库相关内容

2. 顺藤摸瓜 //即通过main函数为切入点，根据import进的类来，挨个查找相关的文件

3. 大海捞针 //如上一条七拐八绕把你转晕了，可以寻求IDE的帮助，如按住ctrl键加左键快速跳转函数定义文件等，或者使用search功能来定位核心文件

欢迎楼下继续补充

哈哈又想了一条，搞恶一下

4 不耻下问   //以上3点都不能满足你，足以说明作者编码习惯之恶劣，逻辑思维之跳跃，请你立即在github上开出issue，大胆质疑作者，并勒令其整改

Answer 2

推荐一个插件：Octotree，可以像 IDE 那样以树形的形式展现项目中的文件。

地址：https://chrome.google.com/web...

一般看项目除了要看 Star 数字，还要看作者提交的 commit 次数、评论以及 issues 处理关闭的速度。并不是所有项目都值得阅读。

至于项目怎么读就和 GitHub 这个上下文没有关系了，每种项目每个人都有自己的习惯和目的，看法也不尽相同，就不再展开了。

Answer 3

• 在线看不方便，所以按以下步骤

• 看到右边有 clone and download 了吗？

• 使用 git 或者下载压缩包

• 使用你的编辑器或者 IDE 进行查看

Answer 4

一般来说，一个写的比较好的开源项目。首先是看readme，然后是doc，一般来说前面两个就足够了。

如果都没有，就可以看看test下面的，如果有的话，test下面基本也能看出怎么用。

如果连test也没有，还非得要用，就只能死啃源码了。