idea使用checkStyle

前言

阅读优雅的代码是一种享受,而看到一团糟的代码通常让人头疼,所以本文介绍下使用checkStyle进行代码检查,帮助团队统一代码规范。

安装checkstyle插件

File--》Settings--》Plugins,之后找到checkStyle插件,进行安装即可

配置默认的checkStyle.xml文件

File--》Settings--》Other Settings--》CheckStyle,之后添加本地默认的checkStyle文件(文件位xml格式)。


代码示例






    
	
	

	
			
			
			

		
		 

		
		

		
		


		
		
		

		
		

		
		
			
		

		
		
			
		

		
		
			
		

		
		
			
		

		
		
        
            
        

		
		
			
		

		
		
			
		

		
		
			
		

		
		
			
			
	  	
		

		
		
		
		
			
		


		
		

		
		

		
		

		
		

		
		
			
		

		
		

		
		
			
		

		

		
		

		
		

		
		

		
		

		
		

		
		
			
			
			
			
			
			
			
			
			
		

		
		

		
		

		
		

		
		

		
		

		
		

		
		

		
		
            
    

		
		
			
		

		
		
		

		
		
			
		

		
		
			
		

		
		
    

执行检查

打开待检查的java类,之后选择定义好的规则,执行即可。



总结

本文介绍的是单个java文件的代码检查,实际上可以在工程中直接引入checkStyle包,之后引入checkStyle文件,并配置可运行方式中有checkStyle来进行全部代码检查,有兴趣的可以自己研究下。









你可能感兴趣的:(idea使用checkStyle)