vlambda博客
学习文章列表

一、前言

最近在其它同事负责的功能上要添加新功能，期间发现了不少问题，比如说：

• 方法上缺少注释、参数含义不明确。
• 变量名含义不明确，各种魔数。
• 代码行数多，注释很少。
• 功能逻辑不太合理。

对每个功能进行review在公司现阶段不太现实，如何简单有效的去提高团队成员的代码可读性、提升代码质量下限？最简单的方法莫过于借助现有的工具了。本文就介绍一下最近笔者在团队推广的3个IDEA插件，即Eclipse Code Formatter、Alibaba Java Coding Guidelines、Save Actions，在不增加人力的情况下尽量去统一团队代码规范。

说明：

• 部分公司的办公电脑不能联网，可参考链接部分给出的插件下载地址，根据idea版本下载对应的版本。

二、安装与使用

2.1 Eclipse Code Formatter

离线安装

配置format规则

使用ctrl+shift+alt+L，即可使用该插件进行格式化。

2.2 Save Actions

每个文件都要显式的ctrl+shift+alt+L进行格式化，对于程序员来说一方面效率低、有点麻烦，另一方面确实容易忘。save actions插件在每次保存文件时，自动触发格式化动作，完美的解决了这个问题。

配置

2.3 Alibaba Java Coding Guidelines

该插件按照阿里出版的《Java开发手册》去检查代码，既支持自动检测、也支持主动检测。鉴于自动检测会比较吃PC机的资源，因此一般都将自动检测关闭。

使用

三、总结

本文给出的三个idea 插件在一定程度上可以提高团队代码质量的下限，促使团队成员在完成功能代码的情况下会多去审视一下自己产出的代码。但对于功能逻辑的审视，特别是核心功能，仍然需要通过定期的code review来完成。

四、参考链接

1、https://plugins.jetbrains.com/plugin/6546-adapter-for-eclipse-code-formatter/versions

2、https://plugins.jetbrains.com/plugin/10046-alibaba-java-coding-guidelines/versions

3、https://plugins.jetbrains.com/plugin/7642-save-actions/versions