资讯专栏INFORMATION COLUMN

idea中使用JavaDoc Sync Plugin

endiat / 1958人阅读

摘要:是一个神奇的东西,也有很多插件很多,近期一直比较执着于快速定义注释相关的插件。模板中使用了一些变量,语法可以参考官方的文档,本文中不做特别介绍图一图二图三参考链接插件官方说明

idea是一个神奇的东西,也有很多插件很多,近期一直比较执着于快速定义java注释相关的插件。

那么要来说一说JavaDoc Sync Plugin这个插件了,在插件仓库里面找javadoc相关的插件的时候,无意中发现的,开始以为纯粹是用来生成类或者方法注释的,仔细看了下介绍,才知道主要目的是校验注释的正确性的,其实就是变相帮你生成注释。

网上关于这个插件的介绍不多,大部分写的不太清楚,所以我想要写一个看的懂的~
下面的截图是idea 2017的截图,要开启这个插件,请打开idea的设置(默认快捷键crtl + alt + s),在搜索框中输入JavaDoc Issues,就会看到(如图一)中的样子了,然后选择JavaDocSyncIssues,勾上后面的选项即可。

开启这个设置之后,将光标移至方法名称所在的行后,即会提示需要生成javadoc(如图二)

不同的注释的模板设置,可以参考(如图三),如果idea中只安装了一个插件的朋友,可能不会有Other Settings这个选项,直接进入JavaDoc Sync Settings这个菜单即可。模板中使用了一些变量,语法可以参考idea官方的文档,本文中不做特别介绍

图一

图二

图三

参考链接:idea 插件官方说明

文章版权归作者所有,未经允许请勿转载,若此文章存在违规行为,您可以联系管理员删除。

转载请注明本文地址:https://www.ucloud.cn/yun/67783.html

相关文章

  • 【Java】gradle简单理解

    摘要:的整体设计是以作为一种语言为导向的,而非成为一个严格死板的框架。它整合了传统的静态代码检查,并对单元测试覆盖率和代码重复率进行数据统计。排除传递依赖有多种原因,远程仓库中不存在,运行时不需要,或者版本冲突。 简介(百度百科) 定义:Gradle是一个基于Apache Ant和Apache Maven概念的项目自动化构建开源工具。它使用一种基于Groovy的特定领域语言(DSL)来声明项...

    bigdevil_s 评论0 收藏0
  • maven仓库jar包发布指南

    摘要:支持的算法公钥对称加密散列压缩不压缩生成密钥对查看公钥将公钥发布到密钥服务器其中为你的公钥查看是否发布成功配置用户名密码配置项目 install gpg brew install gnupg check ➜ ~ gpg --version gpg (GnuPG) 1.4.20 Copyright (C) 2015 Free Software Foundation, Inc. Lice...

    xietao3 评论0 收藏0
  • 开发利器之IntelliJ IDEA学习笔记

    摘要:旨在记录自己的学习过程,方便日后遇到问题是及时查阅复习,另一方面也希望能帮助像笔者一样从来没使用过的人快速熟悉。 这篇文章主要记录的是本人学习使用IntelliJ IDEA的笔记,可能不是特别的详细。旨在记录自己的学习过程,方便日后遇到问题是及时查阅复习,另一方面也希望能帮助像笔者一样从来没使用过IDEA的人快速熟悉IDEA。文章错误之处还请各位大佬批评指正。(文末有本人的微信公众号,...

    马永翠 评论0 收藏0
  • Intelli J IDEA生成javaDoc

    摘要:操作依次点击注意事项如果编辑器默认编码为,可能会出现以下错误编码的不可映射字符这时,需要在设置界面输入命令行参数 操作 依次点击 Tools->Generate JavaDoc... showImg(https://segmentfault.com/img/bV0Ugl?w=807&h=385); 注意事项 如果编辑器默认编码为utf-8,可能会出现以下错误: 编码 GBK 的不可映...

    OnlyMyRailgun 评论0 收藏0
  • IDEA 和 Eclipse 集成开发工具 配置 Java API 帮助文档教程

    摘要:为了达到这个效果,还需要对开发工具进行设置。至此,配置帮助文档就完成了。可以自己调用一个库函数测试一下效果。按照下图配置即可,这样是为了使鼠标光标放到库函数上时,帮助信息以小窗口的方式弹出。 ...

    Gemini 评论0 收藏0

发表评论

0条评论

endiat

|高级讲师

TA的文章

阅读更多
最新活动
阅读需要支付1元查看
<