是否你曾面对一个庞大的、陌生的代码库(比如新公司、新项目),花费数小时梳理文件结构,却在切换几个文件后,就忘记了特定类或方法的核心作用?
Project File Notes 插件彻底解决了这一核心痛点。它允许你为项目中的任何文件或类添加持久化、可同步的 Markdown 格式笔记,并且在你每次打开该文件时,笔记都会自动、即时地出现在你的编辑器侧边。
入职一家企业,代码量特别大,我逐查看个项目目录和文件记不住。想要为每一类大概记录下的笔记。当我点击打开这个类的时候,能看到我记录的注解。
融入ide中。代码仓库最终新增注解仓库,每个类在都会对应生成一个文件类图or文件注解, 新人入职等情况查看代码时快速理解项目。快捷学习新项目,无惧x山代码。希望有更多同学贡献下自己的力量来达成这个终极目标。
Project File Notes 是一个专为 JetBrains 全家桶(IntelliJ IDEA, Android Studio 等) 设计的、批注管理插件。
- 粒度精准: 不仅支持对整个文件(如
.java,.kt,.xml,.gradle)添加批注,未来也支持对文件内的特定类、函数或代码块进行标记。 - Markdown 支持: 批注内容完全基于 Markdown 语法,你可以轻松插入标题、列表、代码块,甚至嵌入类图或流程图(通过 Markdown 图床链接),方便快速回忆和深度理解。
- 即时切换: 当你在编辑器中切换不同的代码文件时,右侧的独立批注面板内容会自动、即时地切换到当前文件的对应笔记。
- 零侵入: 笔记不会存储在项目代码中,不会污染你的 Git 仓库,确保项目干净、纯粹。(倒是希望有个单独的注解仓库,针对每个类储存对应类图和核心目的,遗留项)
- 智能锚定 (关键特性): 批注的关联机制不依赖于代码的绝对行号。它基于文件路径 + 类名/函数名进行锚定。这意味着即使你切换 Git 分支、进行了大量代码重构或修改了文件行号,你的笔记也不会丢失,仍能精准地找到对应代码。
- 团队同步: 提供 笔记导出/导入 功能,支持团队成员间轻松共享批注数据。可将导出的笔记文件放置在组内共享仓库中,实现公共知识的积累和快速同步。
- 项目视图标记: 在 Project View 树中,已添加批注的文件会显示一个醒目的笔记图标标记,让你一眼就知道哪些文件已经有了你的学习笔记。
- 快速操作: 支持快捷键或右键菜单,一键打开批注编辑框。
本插件已上架 JetBrains 官方插件市场,并已在两天内完成三次大版本迭代。 有这个想法时候很激动睡不着,当天迭代出来,持续两天优化解决了各种bug。
- 插件名称:
Project File Notes - 市场链接: [https://plugins.jetbrains.com/plugin/28588-project-file-notes?noRedirect=true]
- GitHub 仓库: [https://plugins.jetbrains.com/plugin/28588-project-file-notes?noRedirect=true]
欢迎下载体验,提出宝贵意见!