IntelliJ JavaDocs 插件使用教程

IntelliJ JavaDocs 插件使用教程

intellij-javadocsIntellij-idea javadocs generator项目地址:https://gitcode.com/gh_mirrors/in/intellij-javadocs

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

IntelliJ JavaDocs 插件的 GitHub 仓库目录结构如下：

intellij-javadocs/
├── .github/
│   └── workflows/
│       └── ci.yml
├── src/
│   ├── main/
│   │   ├── java/
│   │   │   └── com/
│   │   │       └── github/
│   │   │           └── tsergey/
│   │   │               └── javadocs/
│   │   │                   ├── actions/
│   │   │                   ├── annotators/
│   │   │                   ├── config/
│   │   │                   ├── icons/
│   │   │                   ├── inspection/
│   │   │                   ├── settings/
│   │   │                   └── utils/
│   │   └── resources/
│   │       └── META-INF/
│   │           └── plugin.xml
│   └── test/
│       └── java/
│           └── com/
│               └── github/
│                   └── tsergey/
│                       └── javadocs/
│                           └── tests/
├── .gitignore
├── CHANGELOG.md
├── LICENSE
├── README.md
└── build.gradle

目录结构介绍

• .github/workflows/ci.yml: GitHub Actions 的持续集成配置文件。
• src/main/java/com/github/tsergey/javadocs/: 插件的主要源代码目录。
  • actions/: 包含插件的动作类。
  • annotators/: 包含注解器类。
  • config/: 包含配置相关的类。
  • icons/: 包含插件使用的图标资源。
  • inspection/: 包含代码检查相关的类。
  • settings/: 包含设置相关的类。
  • utils/: 包含工具类。
• src/main/resources/META-INF/plugin.xml: 插件的描述文件。
• src/test/java/com/github/tsergey/javadocs/tests/: 插件的测试代码目录。
• .gitignore: Git 忽略文件配置。
• CHANGELOG.md: 更新日志文件。
• LICENSE: 许可证文件。
• README.md: 项目说明文件。
• build.gradle: 项目的构建配置文件。

2. 项目的启动文件介绍

IntelliJ JavaDocs 插件的启动文件是 src/main/resources/META-INF/plugin.xml。这个文件是 IntelliJ 插件的描述文件，包含了插件的基本信息、依赖、动作、扩展点等配置。

plugin.xml 文件内容示例

<idea-plugin>
    <id>com.github.tsergey.javadocs</id>
    <name>JavaDocs</name>
    <version>1.0</version>
    <vendor email="support@example.com" url="http://www.example.com">Your Company</vendor>

    <description><![CDATA[
        Adds JavaDocs generation capabilities to IntelliJ IDEA.
    ]]></description>

    <change-notes><![CDATA[
        Initial release of the JavaDocs plugin.
    ]]>
    </change-notes>

    <depends>com.intellij.modules.platform</depends>

    <extensions defaultExtensionNs="com.intellij">
        <!-- Add your extensions here -->
    </extensions>

    <actions>
        <!-- Add your actions here -->
    </actions>
</idea-plugin>

关键配置项介绍

• <id>: 插件的唯一标识符。
• <name>: 插件的名称。
• <version>: 插件的版本号。
• <vendor>: 插件的提供者信息。
• <description>: 插件的描述信息。
• <change-notes>: 插件的更新日志。
• <depends>: 插件依赖的其他模块。
• <extensions>: 插件的扩展点配置。
• <actions>: 插件的动作配置。

3. 项目的配置文件介绍

IntelliJ JavaDocs 插件的配置文件主要位于 `src/main/java/

intellij-javadocsIntellij-idea javadocs generator项目地址:https://gitcode.com/gh_mirrors/in/intellij-javadocs