1 Star 16 Fork 2

吴汶泽 / jetbrains-code-remark

加入 Gitee
与超过 1200万 开发者一起发现、参与优秀开源项目,私有仓库也完全免费 :)
免费加入
克隆/下载
贡献代码
同步代码
取消
提示: 由于 Git 不支持空文件夾,创建文件夹后会生成空的 .keep 文件
Loading...
README
MIT

Jetbrains Code Remark

一款Jetbrains系IDE代码备注插件,不同于代码注释,它可被应用于只读的源码文件,让你在阅读源码时如虎添翼。

English | 报告问题

演示

如何安装

使用说明

源码是只读文件,如何添加备注?使用该插件让你在阅读框架源码时如虎添翼。

  • 将源码文件使用IDEA打开。

  • 在任何需要的地方,以下三种方式任选其一,触发Popup弹出层,添加内容。

    • Alt + ENTER -> [MARK] Add/Edit remark [推荐]
    • EditorPopupMenu / Tools -> Add remark
  • 在编辑器中使用右键菜单 Remark Navigation 预览当前文件添加的所有备注信息。

  • View -> Tool Windows -> Bookmarks -> Remarks 视图中查看当前项目所有的备注信息。

快捷键

  • 添加/编辑:Alt + ENTER -> [MARK] Add/Edit remark [推荐]
  • 保存:<shift + ENTER>
  • 删除:<shift + DETELE>
  • 取消:<ESC>

可以通过 Preferences - Keymap 搜索 remark ,为指定的操作配置相应的快捷键

如何将代码备注同步到Git仓库?

相关的文件位于${yourProject}/.idea/code-remark.xml,将其加入到Git版本库中即可。

MIT License Copyright (c) 2021 吴汶泽 <wenzewoo@gmail.com> Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

简介

一款Jetbrains系IDE代码备注插件,不同于代码注释,它可被应用于只读的源码文件,让你在阅读源码时如虎添翼 展开 收起
Java
MIT
取消

发行版

暂无发行版

贡献者

全部

近期动态

加载更多
不能加载更多了
Java
1
https://gitee.com/wuwenze/jetbrains-code-remark.git
git@gitee.com:wuwenze/jetbrains-code-remark.git
wuwenze
jetbrains-code-remark
jetbrains-code-remark
main

搜索帮助