深圳幻海软件技术有限公司 欢迎您!

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

2023-02-28

一、前言我们在空闲之余喜欢研究一些经典框架的源码,发现没办法把自己的注释添加上。会给出提示:Fileisread-only很烦,但是为了安全考虑也是没有办法的!这是一个大佬就写了一个IDEA插件,让我们摆脱了这个烦恼!也不会耽误执行!一起安装使用起来哈!二、安装插件找到设置输入:复制private-

一、前言

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

一起安装使用起来哈!

二、安装插件

找到设置输入:

private-notes
  • 1.

如果无法使用就重启IDEA哈,小编直接可以使用!

三、插件使用

1、添加私人注释

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

2、修改私人注解

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

3、操作私人注解

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

  • 删除​
  • 换行
  • 复制
  • 详细

4、私人化配置

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

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

5、注释存放位置

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

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

四、总结

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

可以对插件的作者点个start哈!

private-notes插件作者传送门:https://gitee.com/The-Blind/private-notes。