Easy Javadoc 插件使用教程

1. 项目的目录结构及介绍

Easy Javadoc 插件的 GitHub 仓库地址为：https://github.com/starcwang/easy_javadoc。以下是该项目的目录结构及其介绍：

easy_javadoc/
├── src/
│   ├── main/
│   │   ├── java/
│   │   │   ├── com/
│   │   │   │   ├── github/
│   │   │   │   │   ├── starcwang/
│   │   │   │   │   │   ├── easy_javadoc/
│   │   │   │   │   │   │   ├── config/
│   │   │   │   │   │   │   ├── constants/
│   │   │   │   │   │   │   ├── handler/
│   │   │   │   │   │   │   ├── model/
│   │   │   │   │   │   │   ├── service/
│   │   │   │   │   │   │   ├── utils/
│   │   │   │   │   │   │   ├── EasyJavadoc.java
│   ├── test/
│   │   ├── java/
│   │   │   ├── com/
│   │   │   │   ├── github/
│   │   │   │   │   ├── starcwang/
│   │   │   │   │   │   ├── easy_javadoc/
│   │   │   │   │   │   │   ├── EasyJavadocTest.java
├── .gitignore
├── LICENSE
├── README.md
├── build.gradle
├── settings.gradle

目录结构介绍

• src/main/java/com/github/starcwang/easy_javadoc/：包含插件的主要源代码。
  • config/：配置相关类。
  • constants/：常量定义。
  • handler/：处理逻辑类。
  • model/：数据模型类。
  • service/：服务类。
  • utils/：工具类。
  • EasyJavadoc.java：插件的主类。
• src/test/java/com/github/starcwang/easy_javadoc/：包含测试代码。
  • EasyJavadocTest.java：插件的测试类。
• .gitignore：Git 忽略文件配置。
• LICENSE：项目许可证。
• README.md：项目说明文档。
• build.gradle：Gradle 构建文件。
• settings.gradle：Gradle 设置文件。

2. 项目的启动文件介绍

项目的启动文件是 EasyJavadoc.java，位于 src/main/java/com/github/starcwang/easy_javadoc/ 目录下。该文件是插件的主类，负责初始化和启动插件。

EasyJavadoc.java 主要功能

• 初始化插件配置。
• 注册插件事件监听器。
• 提供插件的主要功能接口。

3. 项目的配置文件介绍

项目的配置文件主要涉及 build.gradle 和 settings.gradle。

build.gradle

build.gradle 是 Gradle 的构建文件，包含项目的依赖管理、任务定义等。

plugins {
    id 'java'
    id 'org.jetbrains.intellij' version '0.6.5'
}

group 'com.github.starcwang'
version '1.0-SNAPSHOT'

sourceCompatibility = 1.8

repositories {
    mavenCentral()
}

dependencies {
    testCompile group: 'junit', name: 'junit', version: '4.12'
}

intellij {
    version '2020.1'
    plugins 'java'
}

patchPluginXml {
    changeNotes """
      Add change notes here.<br>
      <em>most HTML tags may be used</em>"""
}

settings.gradle

settings.gradle 是 Gradle 的设置文件，定义了项目的名称和模块。

rootProject.name = 'easy_javadoc'

以上是 Easy Javadoc 插件