IDEA中给源码添加自己注释——private-notes插件安装使用

﹏ヽ暗。殇╰゛Y 2024-03-24 13:38 8阅读 0赞

### 一、前言 ###

我们在空闲之余喜欢研究一些经典框架的源码，发现没办法把自己的注释添加上。  
会给出提示：`File is read-only`  
很烦，但是为了安全考虑也是没有办法的！  
这是一个大佬就写了一个IDEA插件，让我们摆脱了这个烦恼！也不会耽误执行！  
一起安装使用起来哈！！

### 二、安装插件 ###

找到设置输入：

private-notes

![在这里插入图片描述][a2f4c062148549589701eaa277e80b73.png]  
如果无法使用就重启IDEA哈，小编直接可以使用！

### 三、插件使用 ###

#### 1. 添加私人注释 ####

光标定位到你要添加注释的位置，然后使用快捷键：  
`Alt + P` 可快速添加或者编辑私人注释  
添加完之后直接使用鼠标点击小弹框之外的地方即可保存！

![在这里插入图片描述][80233471f80446bb96bcd0bc8acf2b4e.png]

#### 2. 修改私人注解 ####

找到你要修改的私人注解所在行，输入快捷键：  
`Alt + Enter` 弹出小框继续点击`Enter`，即可进行修改！

![在这里插入图片描述][a43429a56afd433fbd5de007b7164fbf.png]

#### 3. 操作私人注解 ####

`Alt + O` 展示私人注释的其它操作  
我们可以进行一些四种操作：

*  删除
 *  换行
 *  复制
 *  详细

![在这里插入图片描述][eb28326e8d984424aa248ec294bba29b.png]

#### 4. 私人化配置 ####

可以设置展示的字符，如果超过就会显示…  
颜色样式也可以自己来定义！

这里我们发现，写的注释不能够自己添加[制表符][Link 1]，只能在一行的开始，或者在代码后面出现。就是有点别扭哈！不过可以加注释，咱们还要什么自行车啊！！

![在这里插入图片描述][000d0eff84c542339770ff9fb9c145f0.png]

#### 5. 注释存放位置 ####

私人注释 都缓存在 当前用户目录下的 `.privateNotes`文件夹中！

还支持同步到git，这里小编没弄明白，不过本地添加上注解也可以使用了，作者说的好像是整个源码上传到git，还是什么的，不太明白哈，大家有懂的可以留言怎么同步git哈！！

![在这里插入图片描述][8baaf6a0a3a04f9c976aa341beeb6c91.png]

### 四、总结 ###

这样就可以在源码中添加注释了，总的来说还是非常的香！！

可以对插件的作者点个start哈！[private-notes插件作者传送门][private-notes]

[a2f4c062148549589701eaa277e80b73.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/24/340cd864f3a5424db160b05b41d427f1.png
[80233471f80446bb96bcd0bc8acf2b4e.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/24/80e9245823c24b5491e49ada00da6917.png
[a43429a56afd433fbd5de007b7164fbf.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/24/f43a9306408a4f599e90471832dd5d85.png
[eb28326e8d984424aa248ec294bba29b.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/24/71285d91432e4283ab7b53ff8c787f99.png
[Link 1]: https://so.csdn.net/so/search?q=%E5%88%B6%E8%A1%A8%E7%AC%A6&spm=1001.2101.3001.7020
[000d0eff84c542339770ff9fb9c145f0.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/24/0dfa76036d064b8b82be160100c42891.png
[8baaf6a0a3a04f9c976aa341beeb6c91.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/24/b9b23e67408b4f75b300c63e795a8c6c.png
[private-notes]: https://gitee.com/The-Blind/private-notes