有几种方案可以实现"记录文件/类作用 + 点击跳转":

1. CodeTour(最符合需求)

微软官方插件,专门做代码导览:

  • 记录每个文件的作用说明
  • 点击直接跳转到对应文件和代码行
  • 支持录制导览路径
  • 配置保存在 .tours/ 目录,可提交到git

使用Ctrl+Shift+P → CodeTour: Record Tour

2. Markdown + 链接(简单实用)

配合 Markdown All in One 插件:


[GameRenderer](src/control/GameRenderer.cpp) - 游戏主渲染器

  • Ctrl+点击 直接跳转文件
  • 支持行号定位:src/main.cpp#L25
  • 配合 Path Intellisense 自动补全路径

3. Doxygen + Doxygen Documentation Generator

  • 在代码头文件写文档注释
  • 生成HTML文档后内部可跳转
  • 有侧边栏文件树
  • 缺点:需要生成步骤,不是实时的

4. Better Comments + Bookmarks

  • Better Comments:高亮 //! //? 等特殊注释
  • Bookmarks:给文件/行添加书签并写备注
  • 缺点:Bookmarks不支持写长说明

推荐组合

Markdown All in One + Path Intellisense + CodeTour

  • 日常维护用Markdown链接
  • 复杂流程用CodeTour录制导览
  • 新人 onboarding 直接播放Tour

Logo

腾讯云面向开发者汇聚海量精品云计算使用和开发经验,营造开放的云计算技术生态圈。

更多推荐