feat(DOC): 完整地审查了代码，更完整的注释说明

- 无代码修改

types/user/api.ts

@@ -8,6 +8,7 @@ export interface GetHotAuthorsRequest {
 
 // 获取热门作者响应接口
 export interface GetHotAuthorsResponse {
+  // 其实应该用profile返回的
   data: User[]; // 数据列表
   total: number; // 总数
 }
@@ -23,6 +24,7 @@ export interface GetAuthorRankingRequest {
 export interface GetAuthorRankingResponse {
   data: User[]; // 数据列表
   total: number; // 总数
+  // 其实冗余了
   period: 'day' | 'week' | 'month'; // 统计周期
   type: 'posts' | 'views' | 'likes'; // 排序类型
 }

types/user/base.ts

@@ -33,16 +33,17 @@ export interface ChangePasswordRequest {    // 暂时用不到
     newPassword: string;
 }
 
-export interface RefreshTokenRequest {
-    sessionId: string;
-}
+// 目前只用得到session
+// export interface RefreshTokenRequest {
+//     sessionId: string;
+// }
 
-export interface RefreshTokenResponse {
-    sessionId: string;
-}
+// export interface RefreshTokenResponse {
+//     sessionId: string;
+// }
 
-// 用户通知
-export interface UserNotification {         // 暂时用不到
+// 用户通知（暂时用不到）
+export interface UserNotification {         
     id: string;
     userId: string;
     type: NotificationType;

types/user/profile.ts

@@ -20,11 +20,13 @@ export interface UserProfileUpdateResponse {
 
 // 用户关系
 export interface UserRelation {
+    // 当前用户的id
     id: string;
     followerId: string[];
     followingId: string[];
 }
 
+// 当前用户的id由cookie带上
 export interface UserFollowRequest {
     userId: string;
 }

types/user/search.ts

@@ -6,6 +6,7 @@ export interface UserSearchRequest {
 }
 
 export interface UserSearchResponse {
+    // 这里逻辑是对的（可惜暂时不打算做）
     users: Array<UserProfile>
     total: number;
 }