sonar扫描异味小问题解决【异味修复】

   sonar会扫描出很多问题，有些基本的代码格式问题，和*导包问题，unused import问题，这些基本问题可以在idea里面设置下就解决。

   要部署代码的时候，可以选中java文件夹，鼠标右键选reformat code，可以格式化文件夹里的类。鼠标右键选Optimize import，可以把unused import全部去掉。

   类里面如果有*导的包，如：import java.util.*;sonar扫描会建议换成具体的类。当鼠标右键选Optimize import没用的时候，需要按图二设置idea，就有用了。

1、First sentence of Javadoc is missing an ending period

解决：注释的后面缺少一个英文句号“.”,加上即可

 /**
     * 这个文件名的总共有多少条数据.
     */

 2、Summary javadoc is missing.

解决：

加句注释带英文句号就行了

/**
 * 这是干什么的类.
 *
 * @author xxx
 * @date 2021-11-23 09:38:15
 */

 3、At-clause should have a non-empty description

解决：

   在@param 后面的参数 再加说明。如下示例，file加了说明，Exception也加说明

 /**
     * 导入数据.
     * @param file 导入的文件
     * @return
     * @throws Exception 异常
     */

4、'com.xxx.xxx' should be separated from previous import group by one line【应与以前的导入组分隔一行】

解决：导包的设置问题 

如果是idea，可以设置idea的导包顺序和空行设置，选中类鼠标右键optimize import会按导包顺序优化显示导包，分组空行只空一个就行了。

 

5、abbreviation in name 'TESTTEST' must contain no more than '4' consecutive capital letters

缩写必须包含不超过“4”个连续大写字母

解决：变量改为TEST_TEST，或如果是@value注解引入的字段，变量改为驼峰命名规则，不用全部大写加下划线分割。

6、Type Javadoc comment is missing null tag【缺少javadoc注释 】

解决：

加下类注释

/**
 * 这是干什么的类.
 *
 * @author xxx
 * @date 2021-11-23 09:38:15
 */

或者简单点

/**
 * 这是干什么的类.
 *
 */

7、Define and throw a dedicated exception instead of using a generic one

不能抛出通用的异常，如 :

void test() throws Exception;

有的时候是引入的jar包中的方法就抛出了这个异常，这个可以try catch住jar包抛出的这个异常，项目里不要直接抛出这个Exception。