Eclipse使用技巧之代码与注释格式化

迷南。 2024-03-23 18:47 49阅读 0赞

在Eclipse中可以使用 Ctrl+Shift+f 组合按钮对代码格式化，格式化后的代码整洁，具备统一风格。在团队开发中，统一风格的代码非常有必要。  
自动格式化会对代码本身以及注释的部分都进行自动的格式化， 这样在实际开发中可能就会遇到下面的问题：

1.  注释部分： 一般注释部分都已经按照一定的格式和排版进行了部署， 格式化之后反而变乱了，可读性没有了
2.  代码： 某些部分的代码可能有一些逻辑或其他的考虑，我们希望保持设定的换行或缩进风格， 比如Spring Security的安全配置的代码，希望相关的配置放在一起。

这样对应就需要有两个功能了：  
1.注释部分不需要自动格式化  
2. 部分代码在格式化的时候例外， 不进行自动格式化

Eclispe 是支持上面的功能的， 只需要进行相关的设置即可

### 配置代码注释不进行自动格式化 ###

#### 注释格式化的例子 ####

在Eclipse中设置了代码注释模板， 自动产生的类的注释如下：  
![在这里插入图片描述][5ddec38faf6643dbbd6db4c96503ca9d.png]

但是在使用 Ctrl+Shift+f 组合按钮对代码格式化之后， 类的注释的排版就错乱了。  
![在这里插入图片描述][7d32307b3da64ab0a0d4ec13e059ba0f.png]

#### 取消对类注释的格式化 ####

设置如下：  
Windows > preferences > Java > Code Style > Formatter > Edit > Comments。  
![在这里插入图片描述][ee1884bd3553481cbd24b6578d82a53b.png]

取消 “Enable Javadoc comment formatting” 的勾选。

需要注意：Eclipse内置的代码风格是无法修改的， 需要自己创建一个进行修改  
![在这里插入图片描述][8b9fa3f4c29b4cf28cc6a2fd3269d963.png]

### 代码格式化的另外 ###

*  使用 `// @formatter:off` 可以对下面的代码关闭格式化
 *  使用 `// @formatter:on` 则开启自动格式化  
    所以成对的使用`// @formatter:off` 和 `// @formatter:on` ，可以实现位于这两个标签之间的代码不会自动格式化。

// @formatter:off
    	public void method()   {  System.out.println("hello");  }
    	// @formatter:on

此外， 关闭和开启自动格式化的标签也可以自行定制， 设置方式和上面注释的设置类似， 找到`Off/On Tags` 区块进行设置

![在这里插入图片描述][d633f43d837d461fb11b8933ba3e3887.png]

--------------------

[5ddec38faf6643dbbd6db4c96503ca9d.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/14/104c991a2c934e399e18e2db287bf5e6.png
[7d32307b3da64ab0a0d4ec13e059ba0f.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/14/5a1d41fed26f4c83baf2f370cb8850a1.png
[ee1884bd3553481cbd24b6578d82a53b.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/14/a0c6d4a391584035b91c7ac5ada8e19b.png
[8b9fa3f4c29b4cf28cc6a2fd3269d963.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/14/49a1cf181ae94a9a9970cd533cb65202.png
[d633f43d837d461fb11b8933ba3e3887.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/14/2bd2153ad019417c84e2b8c1bdb30e30.png