🏷️ 调整类型注释

src/types/BBS/Response.d.ts

@@ -1,29 +1,38 @@
 /**
- * @file types/BBS/Response.d.ts
- * @description BBS 返回数据类型定义文件
+ * BBS 返回数据类型定义文件
  * @since Beta v0.7.1
  */
 
 declare namespace TGApp.BBS.Response {
   /**
-   * @description 基础返回类型，设计米游社接口请求都是这个类型
-   * @interface Base
+   * 基础返回响应
    * @since Beta v0.3.9
-   * @property {never} retcode - 响应代码
-   * @property {string} message - 响应消息
-   * @property {never} data - 响应数据
-   * @return Base
    */
-  type Base = { retcode: number; message: string; data: never };
+  type Base = {
+    /**
+     * 响应代码
+     * @remarks
+     * 为0表示请求成功，非0表示请求失败
+     * 请求失败时，data 恒为 null
+     */
+    retcode: number;
+    /** 响应消息 */
+    message: string;
+    /** 响应数据 */
+    data: never;
+  };
 
   /**
-   * @description 基础返回类型-带有 data 的
-   * @interface BaseWithData
+   * 成功返回响应
    * @since Beta v0.7.1
-   * @property {0} retcode - 响应代码
-   * @property {string} message - 响应消息
-   * @property {any} data - 响应数据
-   * @return BaseWithData
+   * @remarks 仅用于表示请求成功数据，retcode 恒为 0
    */
-  type BaseWithData<T = unknown> = { retcode: 0; message: string; data: T };
+  type BaseWithData<T = unknown> = {
+    /** 响应代码 */
+    retcode: 0;
+    /** 响应消息 */
+    message: string;
+    /** 响应数据 */
+    data: T;
+  };
 }