Therapi Runtime Javadoc 使用教程

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

Therapi Runtime Javadoc 项目的目录结构如下：

therapi-runtime-javadoc/
├── src/
│   ├── main/
│   │   ├── java/
│   │   │   └── com/
│   │   │       └── github/
│   │   │           └── dnault/
│   │   │               └── therapi/
│   │   │                   └── runtime/
│   │   │                       └── javadoc/
│   │   │                           ├── JavadocHelper.java
│   │   │                           ├── JavadocReader.java
│   │   │                           └── ...
│   │   └── resources/
│   │       └── META-INF/
│   │           └── services/
│   │               └── com.github.dnault.therapi.runtime.javadoc.JavadocProvider
│   └── test/
│       ├── java/
│       │   └── com/
│       │       └── github/
│       │           └── dnault/
│       │               └── therapi/
│       │                   └── runtime/
│       │                       └── javadoc/
│       │                           ├── JavadocHelperTest.java
│       │                           ├── JavadocReaderTest.java
│       │                           └── ...
│       └── resources/
│           └── example/
│               └── example-javadoc.json
├── pom.xml
└── README.md

目录结构介绍

• src/main/java/：包含项目的主要源代码。
  • com.github.dnault.therapi.runtime.javadoc：核心包，包含 Javadoc 解析和处理的类。
• src/main/resources/：包含项目的资源文件。
  • META-INF/services/：包含服务提供者的配置文件。
• src/test/java/：包含项目的测试代码。
  • com.github.dnault.therapi.runtime.javadoc：测试包，包含测试类。
• src/test/resources/：包含测试资源文件。
• pom.xml：Maven 项目的配置文件。
• README.md：项目的说明文档。

2. 项目的启动文件介绍

Therapi Runtime Javadoc 项目没有明确的“启动文件”，因为它是一个库，旨在被其他项目引用和使用。核心功能由 JavadocHelper 和 JavadocReader 等类提供。

3. 项目的配置文件介绍

Therapi Runtime Javadoc 项目的配置文件主要位于 src/main/resources/META-INF/services/ 目录下：

• com.github.dnault.therapi.runtime.javadoc.JavadocProvider：服务提供者配置文件，指定实现 JavadocProvider 接口的类。

此外，项目的依赖和构建配置在 pom.xml 文件中定义。