IDEA设置⽅法参数(@param@return)缺失漏写的检查提⽰
开发团队要求⽅法注释需要按照以下规则书写:
⽅法名 参数 返回值三样缺⼀不可
在之前没有设置注释检查时
是不会像下图这样有⼩红线提⽰的
那在开发过程中如果产⽣漏写(错写和多写均有提⽰ 这⾥不赘述 这⾥只涉及漏写的检查)的情况 只能靠⾁眼去观察 这样的效率和可靠程度不可观
下图是提⽰的内容 可以清晰的看到
缺少了关于’age’和’name’的’@param’标签
缺少了’@return’的标签
这样就达到了 在漏写的情况下很直观的发现问题
设置⽅法:
打开IDEA->File->Settings->搜索javadoc->Inspections->Declaration has Javadoc problems
(仔细看图 不好⽤语⾔描述)
这样设置过后 就会在漏写参数或返回值的时候出现提⽰(⼩红线)
补充说明上图中的’另⼀个⽅⾯’
上图中蓝⾊圈圈围住的设置 是⽤来设置javadoc检查的域(可以设置为只检查某个包下⾯的代码格式)直接上图说明:
param name命名⾃定义 ⾃⼰明⽩就⾏ 这⾥为123(不推荐这样的命名 不直观 仅为举例说明)
会出现如下图所⽰ 点击OK
设置我们配置好的检查域(选择⾃⼰的命名)
⼤功告成!
Tips:
对团队开发来说 还是个不错的推荐 特别对于那些对代码有⼀定要求的团队来说 挺不错的(但这种检查设置只能检查打开的⽂件 它不会去⾃动扫描所有的⽂件去检查)
下⼀篇会说明如何屏蔽不需要的检查
版权声明:本站内容均来自互联网,仅供演示用,请勿用于商业和其他非法用途。如果侵犯了您的权益请与我们联系QQ:729038198,我们将在24小时内删除。
发表评论