IDEA插件系列（41）：Code Reading Note插件——代码阅读笔记

Posted 2021-09-07 二木成林

1.插件介绍

Code Reading Note插件。

对指定代码写下阅读笔记。

• 按主题整理笔记
• 将要保留的代码行组合到主题。这使您始终可以从注释中打开代码行。（如书签功能）
• 通过拖放将代码行按有意义的顺序排列。例如，优先级或流程。

此插件可能不适合经常更改的项目，因为与 note 链接的点是静态的（例如文件路径和行号）。

2.安装方式

第一种方式，是在IDEA上搜索插件进行安装，会适配当前IDEA的版本。

 第二种安装方式是使用离线插件进行安装。

插件下载地址：https://plugins.jetbrains.com/plugin/14068-code-reading-note

3.使用方法

可以在最下方的面板看到一个Code Reading Note选项卡，该选项卡打开的面板就是所写的笔记。

 点击“+”号进行新增笔记

 输入topic的名字

 

 但通常笔记是与代码相关的，将光标放在代码中某一行，然后鼠标右键单击，在出现的面板中选择"Add to Topic“。（注意，至少要先创建一个topic在下面的面板中，右键弹出才会出现"Add to Topic"选项。）

 在弹出的面板中输入topic和备注内容。然后点击前面的topic按钮（这里就是"demo"），就会添加到笔记中。

 再打开底部的Code Reading Note面板，就能看到添加成功的笔记。

 除此之外，还支持笔记的导出和导入。

导出会生成一个xml文件

 该文件的内容如下：

所以代码文件不能经常变化，否则无法索引。