Easy Javadoc: seven years of versions in the readme, and one fix shipped twice
IntelliJ IDEA plugin that automatically generates Javadoc comments.
At a glance
- What is it?
- A Chinese-language IntelliJ IDEA plugin whose entire version history lives in its readme because the repository has no releases, where two consecutive builds claim the same settings-screen crash fix, where one release's changelog entry is that the version number was changed, where a single shortcut does three different things depending on what is selected, and where two of the four troubleshooting answers are the IDE's own formatter.
- Who is it for?
- Easy Javadoc has been maintained for seven years by someone who publishes changelog entries in a readme rather than in releases, and the page is more candid than most plugin listings. Use it if you write Java or Kotlin in the IDE and want a first draft of a comment faster than typing one.
- Can I use it commercially?
- Yes. Apache-2.0 is a permissive licence: you can use, modify and sell software built on it, as long as you keep its copyright and licence notices.
- Is it still maintained?
- Yes. The repository last received commits 46 days ago.
- What is it written in?
- Mainly Java, according to GitHub's language statistics.
Answers come from the project's GitHub data, last synced on November 15, 2026, and from our analysis. They are not legal advice.
Star history
- starcwang/easy_javadoc2,907 ★ · -7
| Repository | 2026-09-24 | 2026-11-15 |
|---|---|---|
| starcwang/easy_javadoc | 2.9k | 2.9k |
-7 Stars in the last 52 days, measured from the daily GitHub snapshot. Compare with other projects
Editorial analysis
The version history is a readme, not a release page
The repository publishes no releases at all. Every version the plugin has ever shipped is recorded as an entry in the readme, running from a first version dated 2019-09-05 to the newest, dated 2026-09-30, which is also the date of the last commit. The distribution channel is the JetBrains plugin marketplace rather than the forge, and the marketplace page is what the repository metadata points at as its homepage. That arrangement has consequences worth naming. There is nothing to diff between two builds, nothing to download from the repository, and no tag to pin. The readme is also the only changelog, so the history a user can consult is the history a maintainer remembered to type, and its accuracy is the whole story. The entry for the newest build records that Microsoft translation moved to a Bing endpoint.
The same crash fix is claimed by two releases
Two builds on the same day, 4.5.4 and 4.5.5, list the same fix. Both say that a null pointer exception prevented the settings screen from loading, and both cite the same issue number. The newer one adds a second line on top: lazy-loading each individual settings view. So a user who installed 4.5.4 and found the crash fixed would have no reason to move to 4.5.5, and a reader of the history sees one fix appear twice. The pattern is not isolated. Two more releases, 4.5.1 and 4.5.2, share a date as well, and the build before the pair contains a changelog entry whose entire content is that a specified version was modified. A history maintained this way is useful for spotting themes, such as several separate fixes for the translation popup's handling of non-English characters, and unreliable for answering which build contains which fix.
One shortcut, three behaviours, and a batch mode that skips Kotlin
The keyboard shortcut is overloaded by what is selected, which is the design decision most likely to confuse a new user. With the cursor resting on a class, method or property, one chord generates the comment. With Chinese text selected, the same chord generates an English name from it. With non-Chinese text selected, it pops up a translation instead. A second chord, with the shift, generates every comment in a class, and that path is explicitly marked as not yet supporting KDoc, so Kotlin users get single-comment generation and no batch mode. Both tables, for Windows and for macOS, carry the same three scopes and one batch row, and both repeat the same warning in the scope column: put the cursor on the item, do not double-click to select it. The troubleshooting section repeats it again, adding that it is not a selection and not the mouse, with three exclamation marks.
Two of the four troubleshooting answers are the formatter
The frequently asked questions section has four entries and two of them are not about the plugin. A single-line comment on a property does not appear because the IDE's default formatter converts single-line comments into multi-line ones, and the fix is in the formatter settings. Document tags come out in the wrong order, including the built-in parameter and link tags, because the default formatter reorders them, and the fix is again in the formatter settings. So the plugin and the editor are fighting over the same lines of text, and the readme is honest about which one wins by default. The other two entries are a font pair and the shortcut not working. The font entry names a system font as Comis Sans MS, which is a misspelling of a typeface most readers will recognise, and the code font as Monaco.
Two free translation endpoints were closed by their vendors
Six translation services are supported, and each of them has a free monthly allowance that the page says is generally enough, with the user applying for their own key. Six application links are given, one per provider, and one of them carries a note that it needs a way past a firewall. Two of those endpoints have already died. The first line of the readme warns that the free Youdao service has been disabled by its official side and asks users to move to another provider, which is accurate, and also redundant, because the history shows that service being switched off in September 2023 and then removed entirely in May 2024. The second is fresher: the newest entry records that Microsoft translation was moved to the Bing free interface because Microsoft closed the previous free interface. A plugin whose output depends on somebody else's free tier is a plugin whose feature set shrinks without a release.
A shortcut conflict with the IDE's own assistant
The third line at the top of the file is a conflict notice, and it is phrased as an instruction rather than a bug report. The AI Assistant plugin in the newest version of the IDE uses the same shortcut as this one, and the page asks you to change one of them, adding a sentence telling readers to stop asking why it does not work. So on a current IDE installation both plugins claim one chord, and the plugin author has decided the resolution belongs to the user rather than to a configurable key. Elsewhere the page does confirm that the shortcut itself can be remapped through the IDE's own keyboard settings, which makes the top-of-file request reasonable but leaves the default broken. The compatibility history shows the plugin chasing IDE versions: a minimum raised from 2019 to 2023.1, then verified against a specific 2026.1.4 build with a later fix for 2026.2.x compatibility.
A placeholder in the contributor list and an empty sponsorship table
The tail of the file has the tells of a page maintained by one person over a long period. Six accounts are credited as contributors, and one of the six handles is the literal word username, which is what a placeholder looks like before it is filled in or removed. Support runs through two chat groups, with the first one marked as full at its stated member limit and closed to new additions. The sponsorship appeal is a single sentence asking readers to buy the author a coffee, followed by a two-column table with nothing in either cell, so the payment link the sentence implies is either an image that did not survive or was never added. Three tutorial videos are credited by name to two individual creators. And the whole document, feature descriptions and troubleshooting included, is written in Chinese, with the marketplace entry point as the only route to it.
Editorial conclusion
Easy Javadoc has been maintained for seven years by someone who publishes changelog entries in a readme rather than in releases, and the page is more candid than most plugin listings. Use it if you write Java or Kotlin in the IDE and want a first draft of a comment faster than typing one. Learn the cursor rule first, since placing the cursor and selecting text are different actions and the plugin only responds to the first. Expect to adjust the IDE's formatter if you care about comment shape or tag order, because the plugin and the formatter disagree. And read the provider list before you configure it, since two of the free endpoints it relied on have been closed by their vendors and you supply your own key for whatever remains.
Frequently asked questions
What does Easy Javadoc do in IntelliJ IDEA?
It is a plugin that generates javadoc and KDoc documentation comments for Java and Kotlin developers, so that a comment can be produced from a method name and its types rather than typed by hand. It supports IntelliJ IDEA 2023.1 and above, is installed from the plugin marketplace by searching for Easy Javadoc, and needs a restart afterwards.
How do I use the Easy Javadoc shortcut?
Place the cursor on a class, method or property, without selecting it, and press ctrl and backslash on Windows or command and backslash on macOS. With text selected, the same chord names Chinese text in English or shows a translation popup instead. Holding shift on a class generates every comment in it, and that batch path does not support KDoc.
Why does the Easy Javadoc shortcut not work?
Two checks are given. Make sure the cursor is resting on the class, method or property name rather than that the text is selected, and then check for conflicting shortcuts in the IDE. The readme also warns at the top of the file that the AI Assistant plugin in recent IDE versions claims the same shortcut and asks you to change one of them.
Why are Easy Javadoc comments the wrong shape or in the wrong order?
Because the IDE's default formatter is reordering them. It converts single-line property comments into multi-line ones and reorders documentation tags including the parameter and link tags. Both behaviours are changed in the IDE's formatting settings rather than in the plugin.
Which translation services does Easy Javadoc use?
Six, each with a free monthly allowance and each requiring your own key: Baidu, Tencent Cloud, Aliyun, Youdao, Microsoft Azure and Google Cloud, the last of which is noted as needing a way past a firewall. The readme warns that the free Youdao service was disabled by its vendor, and the newest entry records that Microsoft translation moved to the Bing interface after the previous free one closed.
Official sources
Add this badge to your README
If you maintain this project, the badge below links readers to this analysis and shows its maintenance status from the daily GitHub snapshot. Paste the markdown into your README; add ?metric=license or ?metric=stars to the image URL for a different field.
[](https://hysenlabs.com/projects/starcwang-easy-javadoc)Star history chart for your README
[](https://hysenlabs.com/projects/starcwang-easy-javadoc)Was this useful?