Using the Alibaba Java Coding Guidelines Plugin in IntelliJ IDEA
This article introduces the Alibaba Java Coding Guidelines plugin for IntelliJ IDEA, explains its rule set and detection modes, and provides step‑by‑step instructions for installing and using the plugin to automatically enforce coding standards in Java projects.
The author, a long‑time Alibaba employee, recommends IntelliJ IDEA as the best Java IDE and introduces the Alibaba Java Coding Guidelines plugin, which implements 53 coding rules from the Alibaba Java Development Manual, mainly using PMD with some IDEA‑specific inspections.
The plugin offers real‑time detection and manual scanning, supports quick‑fix actions for many rules, and categorises violations into Blocker, Critical, and Major levels.
Installation
In the IDEA plugin marketplace, search for alibaba , select Alibaba Java Coding Guidelines , install it, and restart the IDE.
Usage
After installation, a new menu Alibaba Coding Guidelines appears under Tools , providing real‑time code scanning (enabled by default) and the option to trigger scans manually.
The plugin highlights code that violates the guidelines, such as missing author information, and allows users to right‑click in the editor to run a full scan. Results are grouped by severity, each with detailed explanations and, where available, quick‑fix suggestions.
Examples of violations include a Blocker‑level issue for initializing a long variable, a Critical‑level problem with abstract class naming, and a Major‑level warning about trailing comments.
The plugin and the coding manual are hosted on Alibaba's official GitHub repository:
https://github.com/alibaba/p3c
IT Services Circle
Delivering cutting-edge internet insights and practical learning resources. We're a passionate and principled IT media platform.
How this landed with the community
Was this worth your time?
0 Comments
Thoughtful readers leave field notes, pushback, and hard-won operational detail here.