前言
这两天在学习 vue-next 源码的时候,发现编辑器窗口越开越多,代码跳转一两次还能记着怎么返回上一个调用方法,一旦跳转次数过多,人就懵了
一边理代码逻辑思路,一边记文件名,着实难受!于是决定找一找更方便的阅读源码方式或者工具
经过不少折腾,终于在 vscode 扩展商店发现一个很实用的工具 CodeTour
CodeTour 可以在多人协同开发时,给项目添加 新手指引 方便快速熟悉上手新项目,也可以用于 code review,该工具由 Microsoft 开源团队 提供,github 仓库地址 microsoft/codetour
接下来大概讲一下我在使用 CodeTour 阅读源码时的体验
更加方便的书写代码笔记
CodeTour 允许你为任意单行/多行代码添加笔记
CodeTour 独立于源码之外,这使得你不必在源码文件中添加大段注释,避免污染源码
CodeTour 笔记支持 markdown 语法,允许使用 Shell Commands 和 Command Links
更加方便的跳转
CodeTour 以树形目录结构展示项目中代码笔记,这使得在笔记与笔记、文件与文件之间跳转能很轻松的完成
更加方便的逻辑梳理
CodeTour 允许添加多个.tour文件,我们可以将不同逻辑分别纳入不同的.tour文件中,便于梳理代码逻辑
总结
以上几点是我使用 CodeTour 最直观的感受
当然 CodeTour 还有许多非常实用的功能场景,详细的使用方法请移步至:CodeTour 文档
最后分享一个我使用上述方法学习vue-next源码的笔记仓库: vue-next-code-tour
如果你有更好更方便的源码阅读工具或方法,欢迎在评论区交流分享~
thx.