docs 补充项目注释

ruoyi-extend/pom.xml

@@ -12,8 +12,11 @@
     <packaging>pom</packaging>
 
     <modules>
+        <!-- 监控服务 -->
         <module>ruoyi-monitor-admin</module>
+        <!-- Snail AI 服务端 -->
         <module>ruoyi-snailai-server</module>
+        <!-- SnailJob 服务端 -->
         <module>ruoyi-snailjob-server</module>
     </modules>
 

ruoyi-extend/ruoyi-monitor-admin/pom.xml

@@ -35,16 +35,19 @@
             <artifactId>spring-boot-starter-security</artifactId>
         </dependency>
 
+        <!-- Spring Boot Admin 服务端 -->
         <dependency>
             <groupId>de.codecentric</groupId>
             <artifactId>spring-boot-admin-starter-server</artifactId>
         </dependency>
 
+        <!-- Spring Boot Admin 客户端 -->
         <dependency>
             <groupId>de.codecentric</groupId>
             <artifactId>spring-boot-admin-starter-client</artifactId>
         </dependency>
 
+        <!-- lombok -->
         <dependency>
             <groupId>org.projectlombok</groupId>
             <artifactId>lombok</artifactId>

ruoyi-extend/ruoyi-snailai-server/pom.xml

@@ -12,12 +12,14 @@
     <artifactId>ruoyi-snailai-server</artifactId>
 
     <dependencies>
+        <!-- Snail AI 服务端 -->
         <dependency>
             <groupId>com.aizuda</groupId>
             <artifactId>snail-ai-starter</artifactId>
             <version>${snailai.version}</version>
         </dependency>
 
+        <!-- Spring Boot Admin 客户端 -->
         <dependency>
             <groupId>de.codecentric</groupId>
             <artifactId>spring-boot-admin-starter-client</artifactId>

ruoyi-extend/ruoyi-snailai-server/src/main/java/com/aizuda/snail/ai/starter/filter/ActuatorAuthFilter.java

@@ -13,11 +13,22 @@ import java.io.IOException;
 import java.nio.charset.StandardCharsets;
 import java.util.Base64;
 
+/**
+ * Actuator Basic Auth 认证过滤器。
+ *
+ * @author Lion Li
+ */
 public class ActuatorAuthFilter implements Filter {
 
     private final String username;
     private final String password;
 
+    /**
+     * 创建 Actuator 认证过滤器。
+     *
+     * @param username 认证用户名
+     * @param password 认证密码
+     */
     public ActuatorAuthFilter(String username, String password) {
         this.username = username;
         this.password = password;

ruoyi-extend/ruoyi-snailai-server/src/main/java/com/aizuda/snail/ai/starter/filter/SecurityConfig.java

@@ -18,6 +18,11 @@ public class SecurityConfig {
     @Value("${spring.boot.admin.client.password}")
     private String password;
 
+    /**
+     * 注册 Actuator Basic Auth 过滤器。
+     *
+     * @return Actuator 过滤器注册对象
+     */
     @Bean
     public FilterRegistrationBean<ActuatorAuthFilter> actuatorFilterRegistrationBean() {
         FilterRegistrationBean<ActuatorAuthFilter> registrationBean = new FilterRegistrationBean<>();

ruoyi-extend/ruoyi-snailjob-server/pom.xml

@@ -12,6 +12,7 @@
     <artifactId>ruoyi-snailjob-server</artifactId>
 
     <dependencies>
+        <!-- SnailJob 服务端 -->
         <dependency>
             <groupId>com.aizuda</groupId>
             <artifactId>snail-job-server-starter</artifactId>
@@ -24,12 +25,14 @@
             </exclusions>
         </dependency>
 
+        <!-- Scala 运行库 -->
         <dependency>
             <groupId>org.scala-lang</groupId>
             <artifactId>scala-library</artifactId>
             <version>2.13.9</version>
         </dependency>
 
+        <!-- Spring Boot Admin 客户端 -->
         <dependency>
             <groupId>de.codecentric</groupId>
             <artifactId>spring-boot-admin-starter-client</artifactId>

ruoyi-extend/ruoyi-snailjob-server/src/main/java/com/aizuda/snailjob/server/starter/filter/ActuatorAuthFilter.java

@@ -8,11 +8,22 @@ import java.io.IOException;
 import java.nio.charset.StandardCharsets;
 import java.util.Base64;
 
+/**
+ * Actuator Basic Auth 认证过滤器。
+ *
+ * @author Lion Li
+ */
 public class ActuatorAuthFilter implements Filter {
 
     private final String username;
     private final String password;
 
+    /**
+     * 创建 Actuator 认证过滤器。
+     *
+     * @param username 认证用户名
+     * @param password 认证密码
+     */
     public ActuatorAuthFilter(String username, String password) {
         this.username = username;
         this.password = password;

ruoyi-extend/ruoyi-snailjob-server/src/main/java/com/aizuda/snailjob/server/starter/filter/SecurityConfig.java

@@ -18,6 +18,11 @@ public class SecurityConfig {
     @Value("${spring.boot.admin.client.password}")
     private String password;
 
+    /**
+     * 注册 Actuator Basic Auth 过滤器。
+     *
+     * @return Actuator 过滤器注册对象
+     */
     @Bean
     public FilterRegistrationBean<ActuatorAuthFilter> actuatorFilterRegistrationBean() {
         FilterRegistrationBean<ActuatorAuthFilter> registrationBean = new FilterRegistrationBean<>();