[ohscript] 补充注释，满足 javadoc 插件的要求

Author: CodeCasterX

framework/fit/java/pom.xml

@@ -71,7 +71,7 @@
 
         <!-- Maven plugin versions -->
         <maven.antrun.version>3.1.0</maven.antrun.version>
-        <maven.compiler.version>3.9.0</maven.compiler.version>
+        <maven.compiler.version>3.14.0</maven.compiler.version>
         <maven.dependency.version>3.6.1</maven.dependency.version>
         <maven.jar.version>3.3.0</maven.jar.version>
         <maven.javadoc.version>3.11.2</maven.javadoc.version>

framework/ohscript/pom.xml

@@ -62,9 +62,17 @@
         <junit5.version>5.11.4</junit5.version>
         <mockito.version>5.15.2</mockito.version>
 
-        <maven.compiler.version>3.11.0</maven.compiler.version>
-        <maven.surefire.version>3.1.2</maven.surefire.version>
-        <jacoco-maven-plugin.version>0.8.10</jacoco-maven-plugin.version>
+        <!-- Jacoco version -->
+        <jacoco.version>0.8.10</jacoco.version>
+
+        <!-- Maven plugin versions -->
+        <maven.antrun.version>3.1.0</maven.antrun.version>
+        <maven.compiler.version>3.14.0</maven.compiler.version>
+        <maven.dependency.version>3.6.1</maven.dependency.version>
+        <maven.jar.version>3.3.0</maven.jar.version>
+        <maven.javadoc.version>3.11.2</maven.javadoc.version>
+        <maven.surefire.version>3.2.5</maven.surefire.version>
+        <maven.source.version>3.3.0</maven.source.version>
     </properties>
 
     <dependencies>
@@ -184,13 +192,42 @@
                 <artifactId>maven-compiler-plugin</artifactId>
                 <version>${maven.compiler.version}</version>
                 <configuration>
-                    <source>1.8</source>
-                    <target>1.8</target>
+                    <source>${java.version}</source>
+                    <target>${java.version}</target>
+                    <encoding>${project.build.sourceEncoding}</encoding>
+                    <showWarnings>true</showWarnings>
+                    <showDeprecation>true</showDeprecation>
                     <compilerArgs>
                         <arg>-parameters</arg>
                     </compilerArgs>
                 </configuration>
             </plugin>
+            <plugin>
+                <groupId>org.apache.maven.plugins</groupId>
+                <artifactId>maven-javadoc-plugin</artifactId>
+                <version>${maven.javadoc.version}</version>
+                <executions>
+                    <execution>
+                        <id>attach-javadocs</id>
+                        <goals>
+                            <goal>jar</goal>
+                        </goals>
+                    </execution>
+                </executions>
+            </plugin>
+            <plugin>
+                <groupId>org.apache.maven.plugins</groupId>
+                <artifactId>maven-source-plugin</artifactId>
+                <version>${maven.source.version}</version>
+                <executions>
+                    <execution>
+                        <id>attach-sources</id>
+                        <goals>
+                            <goal>jar-no-fork</goal>
+                        </goals>
+                    </execution>
+                </executions>
+            </plugin>
             <plugin>
                 <groupId>org.apache.maven.plugins</groupId>
                 <artifactId>maven-surefire-plugin</artifactId>
@@ -199,7 +236,7 @@
             <plugin>
                 <groupId>org.jacoco</groupId>
                 <artifactId>jacoco-maven-plugin</artifactId>
-                <version>${jacoco-maven-plugin.version}</version>
+                <version>${jacoco.version}</version>
                 <configuration>
                     <destFile>target/coverage-reports/jacoco-unit.exec</destFile>
                     <dataFile>target/coverage-reports/jacoco-unit.exec</dataFile>
@@ -220,6 +257,20 @@
                     </execution>
                 </executions>
             </plugin>
+            <plugin>
+                <groupId>org.apache.maven.plugins</groupId>
+                <artifactId>maven-gpg-plugin</artifactId>
+                <version>3.0.1</version>
+                <executions>
+                    <execution>
+                        <id>sign-artifacts</id>
+                        <phase>deploy</phase>
+                        <goals>
+                            <goal>sign</goal>
+                        </goals>
+                    </execution>
+                </executions>
+            </plugin>
             <plugin>
                 <groupId>org.sonatype.central</groupId>
                 <artifactId>central-publishing-maven-plugin</artifactId>

framework/ohscript/src/main/java/modelengine/fit/ohscript/external/FitExecutionException.java

@@ -16,14 +16,33 @@
  * @since 2023-12-18
  */
 public class FitExecutionException extends ScriptExecutionException {
+    /**
+     * 表示泛服务的唯一标识。
+     */
     private final String genericableId;
 
+    /**
+     * 表示泛服务实现的唯一标识。
+     */
     private final String fitableId;
 
+    /**
+     * 通过泛服务唯一标识和错误信息来初始化 {@link FitExecutionException} 的新实例。
+     *
+     * @param genericableId 表示泛服务的唯一标识的 {@link String}。
+     * @param message 表示错误信息的 {@link String}。
+     */
     public FitExecutionException(String genericableId, String message) {
         this(genericableId, StringUtils.EMPTY, message);
     }
 
+    /**
+     * 通过泛服务唯一标识、错误信息和异常原因来初始化 {@link FitExecutionException} 的新实例。
+     *
+     * @param genericableId 表示泛服务的唯一标识的 {@link String}。
+     * @param message 表示错误信息的 {@link String}。
+     * @param cause 表示异常原因的 {@link Throwable}。
+     */
     public FitExecutionException(String genericableId, String message, Throwable cause) {
         this(genericableId, StringUtils.EMPTY, message, cause);
     }

framework/ohscript/src/main/java/modelengine/fit/ohscript/external/HttpExecutionException.java

@@ -15,8 +15,14 @@
  * @since 2023-12-21
  */
 public class HttpExecutionException extends ScriptExecutionException {
+    /**
+     * 表示 Http 调用的方法。
+     */
     private final String method;
 
+    /**
+     * 表示 Http 调用的地址。
+     */
     private final String url;
 
     /**

framework/ohscript/src/main/java/modelengine/fit/ohscript/external/HttpExecutor.java

@@ -52,7 +52,7 @@ static HttpExecutor create(HttpClassicClient httpClient) {
 
     /**
      * 使用 Http 客户端，向指定地址发送请求。
-     * <p>参数中可能出现的参数如下：
+     * <p>参数中可能出现的参数如下：</p>
      * <ul>
      *     <li>{@link #REQUEST_HEADERS}：表示消息头</li>
      *     <li>{@link #REQUEST_ENTITY}：表示消息体</li>
@@ -74,7 +74,6 @@ static HttpExecutor create(HttpClassicClient httpClient) {
      *         };
      *     };
      * </pre>
-     * </p>
      *
      * @param method 表示 Http 调用的方法的 {@link String}。
      * @param url 表示 Http 调用地址的 {@link String}。

framework/ohscript/src/main/java/modelengine/fit/ohscript/external/support/DefaultFitExecutor.java

@@ -61,6 +61,12 @@ public class DefaultFitExecutor implements FitExecutor {
 
     private final BrokerClient brokerClient;
 
+    /**
+     * 通过 Bean 容器和 FIT 调用代理来初始化 {@link DefaultFitExecutor} 的新实例。
+     *
+     * @param container 表示 Bean 容器的 {@link BeanContainer}。
+     * @param brokerClient 表示 FIT 调用代理的 {@link BrokerClient}。
+     */
     public DefaultFitExecutor(BeanContainer container, BrokerClient brokerClient) {
         this.beanContainer = notNull(container, "The bean container cannot be null.");
         this.brokerClient = notNull(brokerClient, "The fit broker client cannot be null.");

framework/ohscript/src/main/java/modelengine/fit/ohscript/external/support/DefaultHttpExecutor.java

@@ -46,6 +46,11 @@ public class DefaultHttpExecutor implements HttpExecutor {
 
     private final HttpClassicClient httpClient;
 
+    /**
+     * 通过 Http 客户端来初始化 {@link DefaultHttpExecutor} 的新实例。
+     *
+     * @param httpClient 表示 Http 客户端的 {@link HttpClassicClient}。
+     */
     public DefaultHttpExecutor(HttpClassicClient httpClient) {
         this.httpClient = notNull(httpClient, "The http classic client cannot be null.");
     }

framework/ohscript/src/main/java/modelengine/fit/ohscript/script/engine/OhScript.java

@@ -26,6 +26,10 @@ public class OhScript {
 
     private Serializer<AST> serializer;
 
+    /**
+     * 构造函数，创建一个新的OhScript实例
+     * 初始化解析器构建器
+     */
     public OhScript() {
         this.parserBuilder = new ParserBuilder();
     }
@@ -102,6 +106,7 @@ public Object execute(String code) throws OhPanic {
      *
      * @param object 要扩展的对象
      * @param code ohscript代码
+     * @param <T> 表示要扩展的对象的类型的 {@link T}。
      * @return 扩展后的对象
      * @throws Exception 异常
      */
@@ -115,6 +120,7 @@ public <T> T extend(T object, String code) throws Exception {
      *
      * @param clazz 要实现的类
      * @param code ohscript代码
+     * @param <T> 表示实现的类型的 {@link T}。
      * @return 一个实现类的对象
      * @throws Exception 异常
      */

framework/ohscript/src/main/java/modelengine/fit/ohscript/script/errors/GrammarSyntaxException.java

@@ -12,6 +12,11 @@
  * @since 1.0
  */
 public class GrammarSyntaxException extends IllegalArgumentException {
+    /**
+     * 语法错误异常构造函数
+     * 
+     * @param info 错误信息
+     */
     public GrammarSyntaxException(String info) {
         super(info);
     }

framework/ohscript/src/main/java/modelengine/fit/ohscript/script/errors/OhPanic.java

@@ -14,8 +14,14 @@
  * @since 1.0
  */
 public class OhPanic extends Exception {
+    /**
+     * 语法节点，表示错误发生的位置
+     */
     private final SyntaxNode node;
 
+    /**
+     * 错误代码，用于标识不同类型的错误
+     */
     private final Integer code;
 
     /**