IDEA设置方法参数(@param/@return)缺失/漏写的检查提示

老版本

开发团队要求方法注释需要按照以下规则书写：
方法名 参数 返回值三样缺一不可

在之前没有设置注释检查时
是不会像下图这样有小红线提示的
那在开发过程中如果产生漏写(错写和多写均有提示 这里不赘述 这里只涉及漏写的检查)的情况 只能靠肉眼去观察 这样的效率和可靠程度不可观

下图是提示的内容 可以清晰的看到
缺少了关于’age’和’name’的’@param’标签
缺少了’@return’的标签
这样就达到了 在漏写的情况下很直观的发现问题

设置方法：
打开IDEA->File->Settings->搜索javadoc->Inspections->Declaration has Javadoc problems
（仔细看图 不好用语言描述）

这样设置过后 就会在漏写参数或返回值的时候出现提示(小红线)

补充说明上图中的’另一个方面’
上图中蓝色圈圈围住的设置 是用来设置javadoc检查的域(可以设置为只检查某个包下面的代码格式)
直接上图说明:




命名自定义 自己明白就行 这里为123(不推荐这样的命名 不直观 仅为举例说明)

会出现如下图所示 点击OK

设置我们配置好的检查域(选择自己的命名)



大功告成！

Tips:
对团队开发来说 还是个不错的推荐 特别对于那些对代码有一定要求的团队来说 挺不错的
（但这种检查设置只能检查打开的文件 它不会去自动扫描所有的文件去检查）

下一篇会说明如何屏蔽不需要的检查

2022.1版本