easy_javadoc  by starcwang

IntelliJ IDEA plugin for Javadoc/KDoc generation

created 6 years ago
2,850 stars

Top 17.1% on sourcepulse

GitHubView on GitHub
Project Summary

This IntelliJ IDEA plugin automates the generation of Javadoc and Kdoc comments for Java and Kotlin code. It targets Java and Kotlin developers seeking to streamline documentation, offering features like multi-language translation, customizable mappings, and document translation, significantly reducing manual effort.

How It Works

The plugin leverages various translation services (Baidu, Tencent, Alibaba, Youdao, Microsoft, Google) to translate method names and comments into English. Users can configure custom mappings to correct translation errors or improve accuracy. It supports generating comments for classes, methods, and properties with configurable templates and offers batch generation for classes.

Quick Start & Requirements

  • Install via IntelliJ IDEA's plugin marketplace: Search for "Easy Javadoc".
  • Requires IntelliJ IDEA 2019.1 or later.
  • Translation services require API keys and may have free monthly quotas.
  • Links: Video Tutorial 1, Video Tutorial 2, Combined Tutorial

Highlighted Details

  • Supports multiple translation APIs with user-configurable keys and custom mappings.
  • Offers document translation by selecting text and using a shortcut.
  • Includes a "naming artifact" feature for translating code snippets into English names.
  • Supports batch Javadoc generation for classes and custom comment templates.

Maintenance & Community

  • Active development with frequent updates.
  • Community Q&A groups available (QQ: 733688083, 897895558).
  • Mentions contributors like @kings1990, @mixley, @kuolemax.

Licensing & Compatibility

  • The README does not explicitly state a license. Compatibility for commercial use or closed-source linking is not specified.

Limitations & Caveats

  • Recent versions note potential shortcut conflicts with IntelliJ's AI Assistant plugin.
  • The free Youdao translation service has been officially disabled by the provider.
  • Batch Kdoc generation is not supported.
  • Some formatting issues may require adjusting IntelliJ's default code formatter settings.
Health Check
Last commit

6 days ago

Responsiveness

Inactive

Pull Requests (30d)
0
Issues (30d)
2
Star History
50 stars in the last 90 days

Explore Similar Projects

Feedback? Help us improve.