# starcwang/easy_javadoc

**Attribution required: if you use, quote, or summarise this content, you must credit and link back to [awesome-repositories.com](https://awesome-repositories.com/repository/starcwang-easy-javadoc).**

2,899 stars · 146 forks · Java · apache-2.0

## Links

- GitHub: https://github.com/starcwang/easy_javadoc
- Homepage: https://plugins.jetbrains.com/plugin/12977-easy-javadoc
- awesome-repositories: https://awesome-repositories.com/repository/starcwang-easy-javadoc.md

## Description

easy_javadoc is an AI-powered documentation tool and generator for Java. It functions as an editor integration that creates structured documentation comments for classes, methods, and properties by translating code identifiers into natural language.

The system utilizes translation services and large language models to automate the creation of documentation. It includes a technical translation utility that allows for custom terminology mappings to ensure specific industry terms remain consistent across the generated text.

The tool supports both individual member documentation and batch generation for entire classes. It integrates directly into the editor workflow to insert generated comments into source files and provides utilities for converting selected text into a target language.

## Tags

### Programming Languages & Runtimes

- [Documentation Comment Generators](https://awesome-repositories.com/f/programming-languages-runtimes/code-commenting/documentation-comment-generators.md) — Uses large language models to automatically create structured documentation comments from code structure and identifiers.
- [Javadoc Generation](https://awesome-repositories.com/f/programming-languages-runtimes/javadoc-generation.md) — Automatically generates structured Javadoc comments using translation services and large language models.
- [Batch Generation](https://awesome-repositories.com/f/programming-languages-runtimes/code-commenting/documentation-comment-generators/batch-generation.md) — Produces documentation comments for all members of a Java class in a single action. ([source](https://cdn.jsdelivr.net/gh/starcwang/easy_javadoc@master/README.md))

### Content Management & Publishing

- [AI Documentation Assistants](https://awesome-repositories.com/f/content-management-publishing/documentation-knowledge-management/ai-documentation-assistants.md) — Provides an AI-powered editor integration that generates class and method descriptions via identifier translation.

### Development Tools & Productivity

- [Code Identifier Translators](https://awesome-repositories.com/f/development-tools-productivity/code-identifier-translators.md) — Converts selected code identifiers into a target language or translates non-native text within the editor. ([source](https://cdn.jsdelivr.net/gh/starcwang/easy_javadoc@master/README.md))
- [External Translation API Bridges](https://awesome-repositories.com/f/development-tools-productivity/external-translation-api-bridges.md) — Provides a bridge to send code tokens to remote translation services for natural language conversion.
- [Java Documentation Tools](https://awesome-repositories.com/f/development-tools-productivity/java-documentation-tools.md) — Produces standardized documentation for Java classes and members to accelerate technical writing.
- [Automated Documentation Generation](https://awesome-repositories.com/f/development-tools-productivity/project-scaffolding-config-code-generation/code-generation/automated-documentation-generation.md) — Automatically generates Javadoc comments for classes and methods to accelerate the coding process.
- [Text Editor Plugin Integrations](https://awesome-repositories.com/f/development-tools-productivity/text-editor-plugin-integrations.md) — Integrates directly into the IDE's text manipulation API to insert generated documentation into source files.
- [Java Documentation Workflows](https://awesome-repositories.com/f/development-tools-productivity/java-documentation-workflows.md) — Streamlines the writing of API documentation directly within the editor to keep comments synced with code.

### Testing & Quality Assurance

- [AST Extraction](https://awesome-repositories.com/f/testing-quality-assurance/static-code-analysis/ast-extraction.md) — Parses Java source code into abstract syntax trees to isolate class and method names for translation.

### Software Engineering & Architecture

- [Translation Term Mapping](https://awesome-repositories.com/f/software-engineering-architecture/glossaries/glossary-and-acronym-managers/translation-term-mapping.md) — Overrides automated translation outputs using custom key-value pairs to ensure technical terminology consistency.
- [Identifier-to-Term Mappings](https://awesome-repositories.com/f/software-engineering-architecture/localization/language-translations/technical-manual-translations/identifier-to-term-mappings.md) — Maps code identifiers to specific technical terms to ensure documentation accuracy in target languages.