# IntellijPlugin-ExposeJavadoc

**Repository Path**: terrason/IntellijPlugin-ExposeJavadoc

## Basic Information

- **Project Name**: IntellijPlugin-ExposeJavadoc
- **Description**: Intellij IDEA 插件，可以将实例变量上的JavaDoc暴露到Getter和Setter的定制模版中。
- **Primary Language**: Java
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 12
- **Forks**: 1
- **Created**: 2019-05-09
- **Last Updated**: 2025-05-29

## Categories & Tags

**Categories**: idea-plugins

**Tags**: None

## README

ExposeJavadoc
=====================

Jetbrains Plugin : https://plugins.jetbrains.com/plugin/12351-exposejavadoc

An Intellij IDEA plugin for enabling `$field.javadoc` 
in the template script when generating Getter or Setter.

编辑Getter或Setter模版时，Intellij IDEA 默认无法获取对应变量上的JavaDoc文档，
ExposeJavadoc插件给你最需要的`$field.javadoc`。

你可以在模版头部插入：
```
#if($field.javadoc)
$field.javadoc ##
#end

```
就可以在生成Getter或Setter方法时附带上对应属性的JavaDoc。
![Usage Demo](src/main/resources/ExposeJavaDoc-Usage.gif)