Merge pull request '添加get注释' (#43) from zhutt into main

Reviewed-on: #43

api/class_api.py

@@ -47,18 +47,19 @@ def get_classes( id:int|None = None                                  # id参数
         return ClassResponse( code = 404,detail = '没有符合条件的班级，请检查输入是否有误')    # 返回404响应，提示没有符合条件的提示给前端
 
 
-@classes_router.get('/student-count', summary='查询每个班级学生人数')
-def get_class_student_count( class_id:int|None = None
+# ————定定义查询符合查询条件的班级的总学生人数信息的接口函数————
+@classes_router.get('/student-count', summary='查询每个班级学生人数')           # get查询请求
+def get_class_student_count( class_id:int|None = None                            # id参数接收前端输入的数据，声明是整数，可以为空默认为空
                            , class_no:str|None = None                            # class_no参数接收前端输入的数据，声明是字符串，可以为空默认为空
                            , class_name:str|None = None                          # class_name参数接收前端输入的数据，声明是字符串，可以为空默认为空
                            , page:int = 1                                        # page参数接收前端输入的数据，声明是整数，默认是1
                            , page_size:int = 5                                   # page参数接收前端输入的数据，声明是整数，默认是5
                            , db=Depends(get_db)                                  # 参数db依赖于数据库会话的上下文管理器
                            ):
-    t,r = get_class_student_count_dao(class_id,class_no,class_name,page,page_size,db)
-    if r:
-        return ClassResponse(total=t, data=r)
-    return ClassResponse(code=404, detail='没有班级数据')
+    t,r = get_class_student_count_dao(class_id,class_no,class_name,page,page_size,db)   # 变量t,r用来接收dao层get_classes_dao函数的返回值，执行函数时以前端输入的id , class_no , class_name , page , page_size 、db依赖函数入参
+    if r:                                                  # 判断 DAO 层的返回结果，如果为True
+        return ClassResponse(total=t, data=r)              # 返回成功响应，携带符合条件的数据给前端
+    return ClassResponse(code=404, detail='没有班级数据')    # 如果 DAO 层返回的结果为False，返回404响应，提示没有符合条件的提示给前端