如何看注解的源码_源码剖析一定要看的一篇文章——如何做源码剖析?

9ea47ce4f756559b68b6c1de14c964a1.png

本文约定了一套优秀的源码流程图绘制规范,并以PostgreSQL的建表流程举例,由于保守公司业务和技术机密以及出于方便考虑,选择了PostgreSQL最基本的建表流程来举例,没有涉及更复杂的技术。

源码剖析的三大利器有:1、源码阅读器(Source Insight、Jetbrains套装等);2、函数调用流程剖析;3、思维导图。

规范

182ba4fb724e5d603e3c51f80acf88f6.png
源码剖析流程图绘制规范

1、 细线箭头表示在同一层调用深度的、先后运行的函数流程;

2、 蓝色实心箭头表示进入箭头起点处函数或循环体的内部,即蓝色实心箭头之后的函数流程比箭头前的函数或循环体流程要深一层;

3、 灰色实心箭头表示退出箭头起点处的函数或循环体,即灰色实心箭头之后的函数流程比箭头前的函数或循环体流程要浅一层;

4、 用紫色字体表示全局变量;

5、 用红色字体表示关键的函数调用;

6、 通过不同的背景颜色来帮助区分不同调用深度的函数流程;

7、矩形右上角小矩形的数字指示建议阅读顺序。

举例

552c0036de6a7fbe16f13cb3a046e675.png
PostgreSQL建表流程

配合思维导图作分析

adda5b8b38205262cdc141223ab50e83.png

源码剖析约定的规范和方法

【分享】【通用】【代码源码剖析】

  1. 定义跳转
    1. VSCode系列可跳转到定义的变量更多,SI很多很常见的变量跳转不过去
  1. 其他能力
    1. SI最强
  1. linux c++ 源码阅读神器 source insight 支持函数和变量定义跳转
  2. CLion查找变量的速度比Source Insight快n个数量级,CLion基本都是毫秒或秒级
    1. 查看和上个commit的差异 右键-git-history-双击commits记录
  1. 剖析主要类以及其主要【对外】接口
  2. 剖析主流程和函数调用流程,目前感觉用思维导图最好【思维导图】
    1. 规定1:
      1. 同一层的是属于同一层被调用的函数
      2. [xxx.cpp. line n - line m] 表示被使用的位置
      3. /xxx.cpp. line n表示实现函数的位置
  1. 对于单个函数,剥离出主干部分
  2. 约定2:
    1. 删除线标记删除的代码
    2. 下划线表示新增的代码

源码剖析流程图绘制规范:

1、 细线箭头表示在同一层调用深度的、先后运行的函数流程;

2、 蓝色实心箭头表示进入箭头起点处函数或循环体的内部,即蓝色实心箭头之后的函数流程比箭头前的函数或循环体流程要深一层;

3、 灰色实心箭头表示退出箭头起点处的函数或循环体,即灰色实心箭头之后的函数流程比箭头前的函数或循环体流程要浅一层;

4、 用紫色字体表示全局变量;

5、 用红色字体表示关键的函数调用;

6、 通过不同的背景颜色来帮助区分不同调用深度的函数流程;

7、矩形右上角小矩形的数字指示建议阅读顺序。

gs_expand -t redistribute [--vacuum-full] [--fast-redis] [--parallel-jobs=NUMBER] [--buildredistb]

[--redis-mode=MODE] [--time-out=SECS] [-l LOGFILE]

【源码阅读系列文章】

平时喜欢琢磨开源项目,以及模仿着造轮子。一个命令导出,然后逐个checkout,已成习惯,糙快猛。

$ git log --oneline --reverse > commits.txt

> 9c7ba8d init project

> 34085ca add xx intro

> 8032757 support dynamic route

  1. 经验,从第一个最小可用版本发布前的commits读起

git log --reverse 倒序展示log

GitHub 阅读开源代码小技巧:Git历史记录快速翻页式签出

vscode有个gitlen插件可以很方便的查看历史记录。

  • 0
    点赞
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值