欢迎您访问程序员文章站本站旨在为大家提供分享程序员计算机编程知识!
您现在的位置是: 首页  >  IT编程

IDEA如何对具有只读权限的源代码做注释

程序员文章站 2022-06-17 22:15:06
首先问一下你的需求是什么?我的需求仅仅是注释一些API的用法,而非注释底层的实现原理。比如你首次接触mybatis,看到这*的文档:由于jar包是受保护的,不允许在源码上做写入操作,只能退而求其次:用maven将javaDoc下载下来:......

首先问一下你的需求是什么?
我的需求仅仅是注释一些API的用法,而非注释底层的实现原理。前者仅仅是临时用到了在API上做一下笔记,后者是专门抽出时间研究底层的实现,这一点我建议参考B站上的一个视频:如何在IDEA上专门学习源码

回到这篇文章,比如你首次接触mybatis,结果java文档一个注释也没有。
由于jar包是受保护的,不允许在源码上做写入操作,只能退而求其次:
用maven将javaDoc下载下来并解压,在Chrome上直接做注释
IDEA如何对具有只读权限的源代码做注释
想法是很不错的,我说一下我遇到的几个困难:

  1. IDEA怎么快速调出外部文档?
    IDEA有快捷键:鼠标停在某个元素上,按住Shift+F1,直接在chrome(默认浏览器)中打开
  2. 如何确保调出的外部文档是本地文件而不是线上文档?
    IDEA如何对具有只读权限的源代码做注释
  3. 如何在chrome上直接编辑html文件?
	document.designMode = "on"//在控制台上输入此命令,可以直接编辑	
  1. 这个命令可以编辑文件,但是一刷新就失效了,如何持久化保存?
    ctrl+s这个命令是保存文件,没什么好说的,关键是:如何快速保存并覆盖原文件(因为java文档的路径实在是太长了,路径不好定位)?
    这个时候推荐小工具:Listary(我也是看知乎来的,反正挺出名的,检索文件很快)

总结:步骤看似挺多,准备工作做好了以后,把你的主要心思放在做注释上就好了,另外我是极其不推荐在线上文档做笔记的,一个是做笔记的插件不好用,再一个就是线上不放心,做的笔记保存在云上,万一哪天删了呢。还有的人图省事,直接建一个文档,复制粘贴后,做零散的笔记,各有千秋吧,经常用IDEA的,直接快捷键就可以调出修改的文档来,互为补充吧!

补充:关于可见即可得的html文件编辑器,其实有很多软件,这里再推荐一个:amaya,反正我是觉得命令行编辑文件挺不错的,当然想用的也可以用一下

本文地址:https://blog.csdn.net/landada123/article/details/107350882

相关标签: java