如何轻松阅读 GitHub 上的项目源码

前言

" Hackers, likewise, can learn to program by looking at good programs -- not just at what they do, but at the source code. "--- Paul Graham

阅读优秀项目的源码是提高编程能力的一个有效有手段。 因此,有着众多开源项目的 GitHub 是一个不可多得的学习宝库。 那么,问题来了,如何方便阅读这些源码? 下面以 wordPress 项目为例,介绍 3 种方式

  • 下载源码到本地用 IDE 阅读
  • 直接用 GitHub 的代码浏览功能
  • 使用 coding.net 的 CodeInsight 来查看

下载源码到本地用 IDE 阅读

  • 首先下载源码,如下图所示可以选择 clone 到桌面和下载 zip 文件两种方式
图片
图片
  • 用本地 IDE 打开

代码的阅读不同于普通文本,需要高亮,套转到定义,文档结构树等辅助手段才能方便的阅读。普通的文本编辑器或阅读器根本无法满足需求。因此,用 IDE 打开最为方便。

这是最直接的一种方式,而且也可边看边运行代码。

但如果就只是浏览代码来说还是过于繁琐

首先,你得装个 IDE

再者,就我个人来说我不太喜欢自己的计算机上有太多不常用的项目,下载了又删很麻烦

直接用 GitHub 的代码浏览功能

点击文件 " wp-comments-post.php " 可以看到高亮的文件。 如下图所示

图片
图片

图片
图片

这样虽然操作简单,但仅有代码高亮的功能,看起来还是不太方便。

使用 coding.net 的 CodeInsight 来查看

个人比较喜欢这种方式,所以重点介绍

  • 注册一个 coding.net 账号

  • 选择导航栏上的 “ + ” ,点击创建项目


    图片
    图片
  • 输入项目名,描述,以及 GitHub 上 WordPress 的 “HTTPS clone URL”,点击“创建”

    图片
    图片

  • 创建项目后会自动跳到项目首页,依次点击左侧导航栏的“代码”,再点击菜单栏上的“代码阅读”,最后点击创建新的阅读版本


    图片
    图片
  • 输入版本“master”, 然后填写备注,点击创建即可

图片
图片
  • 等待分析完毕后就可以点击去阅读代码了


    图片
    图片

CodeInsight 的 Killer Feature

  • 查看项目的文件结构(界面左侧树状图)
  • 查看当个文件的内部结构,点击索引,即可跳到文件相应位置( 右上角的 structure )
  • 同时查看多个文件,通过 tab 方便切换


    图片
    图片
  • 将鼠标放到相应函数上,即可显示该函数的定义。
  • 点击函数,可以显示函数内部代码


    图片
    图片

当然,这个新上线的功能的槽点也很多,支持的语言太少,Java, C/C++等主流语言没有支持。点击查看函数内部实现时,比较卡。

coding 团队说他们以后会陆续支持这些语言,并且改进性能问题。那我就坐等升级更新啦

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 159,716评论 4 364
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 67,558评论 1 294
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 109,431评论 0 244
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 44,127评论 0 209
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 52,511评论 3 287
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 40,692评论 1 222
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 31,915评论 2 313
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 30,664评论 0 202
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 34,412评论 1 246
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 30,616评论 2 245
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 32,105评论 1 260
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 28,424评论 2 254
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 33,098评论 3 238
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 26,096评论 0 8
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 26,869评论 0 197
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 35,748评论 2 276
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 35,641评论 2 271

推荐阅读更多精彩内容

  • Android 自定义View的各种姿势1 Activity的显示之ViewRootImpl详解 Activity...
    passiontim阅读 170,569评论 25 707
  • 落日长河游, 云霞忘忧愁。 悲喜淡笑间, 功名付水流。
    宗林的李阅读 356评论 8 5
  • 之前在朋友圈发了《你好,旧时光》的简评,好多人追我要读后感。其实读后感这种东西和很多事一样,都需是“一鼓作气,再而...
    白露微霜阅读 648评论 0 50
  • 人之初,性本善。我们一生下来,都是一张没有涂鸦的白纸,随着时间的推移,我们都一点一点的成熟,接触的人越来越多,牵扯...
    小花花_阅读 263评论 0 1