很多开源项目的注释写得很详细,可以快速导出成 html 在线文档,非常棒。


但是我在写代码的时候,直接看源码里面的注释比较难受。本来英文就很费劲了,还掺杂 doc 语法,又有 html 语法。心想肯定有插件可以阅读解析之后的文档,也不用去官方文档里看。
原来 jetbrains 家族的 Ide 都带一个 Quick Documentation 的功能,只是我自己没用过罢了。当遇到先查看文档解释的方法时,鼠标 hover 时,在 mac 上默认的快捷键是 fn + F1

然后再按一次 fn + F1 就从弹窗切换到左边栏了,可以点击注释里面的相关方法链接,就会跳转到相关方法的文档上,同时还可以回退回来,非常方便。


还可以配置鼠标 hover 延时 x ms 之后自动显示,通过如下方式配置,这样鼠标 hover 在某个方法的时候就会自动弹层显示文档里。

同时在我们使用别人的包的时候,直接下来看见很多方法,不太确定的时候,也可以在这种情况直接按快捷键出来文档。

jetbrains 产品很强大,只是我们没有那么多时间来研究,相信很多人已经早就知道了,佛系发帖,保持初心。如果你没用过这个功能,希望对你有帮助。
文章转载自程序员跑路笔记,如果涉嫌侵权,请发送邮件至:contact@modb.pro进行举报,并提供相关证据,一经查实,墨天轮将立刻删除相关内容。




