eclipse java源代码格式化

最新推荐文章于 2023-04-26 15:27:21 发布

wangqiaowqo

最新推荐文章于 2023-04-26 15:27:21 发布

阅读量312

点赞数

CC 4.0 BY-SA版权

文章标签：开发工具 java

本文链接：https://blog.youkuaiyun.com/wangqiaowqo/article/details/84602078

本文提供了一步到位的Eclipse、IntelliJ IDEA等IDE配置Java源代码格式化及Checkstyle检查风格的方法，包括设置、导入模板、添加规则文件等步骤，并详细解释了实际开发中的注释规范。

java源代码格式化配置文件请下载
eclipse配置方法：

eclipse --> Window --> Preferences --> Java --> Code Style --> Formatter --> Import

Checkstyle代码风格配置文件请下载
eclipse配置方法：

eclipse --> Window --> Preferences --> Checkstyle --> New... --> Type: 选择"External Configuration File" ...

Intellij Idea配置方法：

setting --> Plugins --> Browse Repositories 查找到checkstyle,双击安装checkstyle插件，重启ide后，checkstyle功能
即位于settings列表中，点击进入 -->Add 添加规则文件，并置为Active状态。
对于12.0的idea，安装的应该是checkstyle for idea 3.9.2这个版本，目前这个版本去掉了"DoubleCheckedLocking"检测模块，
所以需要相应的在规则文件中注释掉"DoubleCheckedLocking"这个module。在实际开发中注意不要使用这种风格的编程就好了。

注意：
Checkstyle只检查*.java文件
测试代码(即maven工程中src/test/java/*)不做检查
目前Checkstyle的配置不对代码注释做检查，代码注释请按如下原则处理
接口(interface)方法必须注释（说明方法的作用，参数，返回值）
如果在代码中写注释，就尽量写清楚明了，不要写别人看不懂的注释
工具类的公有方法必须注释（说明方法的调用方法，参数，返回值）

----------------------------------------------------------------
注释的修改和添加
Window --> Java --> Code Style --> Code Templates --> Comments -->Types

/**
* @author ${user}
* @date ${date} ${time}
* ${tags}
*/

Automatically add comments for new methods and types 打勾
http://blog.163.com/lizhenming_2008/blog/static/765583332011115112725806/