chore: add documentation comments and stylecop rules

src/Api/TakeoutSaaS.AdminApi/Controllers/SystemParametersController.cs

@@ -31,7 +31,10 @@ public sealed class SystemParametersController(IMediator mediator) : BaseApiCont
     [ProducesResponseType(typeof(ApiResponse<SystemParameterDto>), StatusCodes.Status200OK)]
     public async Task<ApiResponse<SystemParameterDto>> Create([FromBody] CreateSystemParameterCommand command, CancellationToken cancellationToken)
     {
+        // 1. 创建系统参数
         var result = await mediator.Send(command, cancellationToken);
+
+        // 2. 返回创建结果
         return ApiResponse<SystemParameterDto>.Ok(result);
     }
 
@@ -50,6 +53,7 @@ public sealed class SystemParametersController(IMediator mediator) : BaseApiCont
         [FromQuery] bool sortDesc = true,
         CancellationToken cancellationToken = default)
     {
+        // 1. 组合查询参数
         var result = await mediator.Send(new SearchSystemParametersQuery
         {
             Keyword = keyword,
@@ -60,6 +64,7 @@ public sealed class SystemParametersController(IMediator mediator) : BaseApiCont
             SortDescending = sortDesc
         }, cancellationToken);
 
+        // 2. 返回分页结果
         return ApiResponse<PagedResult<SystemParameterDto>>.Ok(result);
     }
 
@@ -72,7 +77,10 @@ public sealed class SystemParametersController(IMediator mediator) : BaseApiCont
     [ProducesResponseType(typeof(ApiResponse<object>), StatusCodes.Status404NotFound)]
     public async Task<ApiResponse<SystemParameterDto>> Detail(long parameterId, CancellationToken cancellationToken)
     {
+        // 1. 查询参数详情
         var result = await mediator.Send(new GetSystemParameterByIdQuery(parameterId), cancellationToken);
+
+        // 2. 返回详情或 404
         return result == null
             ? ApiResponse<SystemParameterDto>.Error(ErrorCodes.NotFound, "系统参数不存在")
             : ApiResponse<SystemParameterDto>.Ok(result);
@@ -87,12 +95,16 @@ public sealed class SystemParametersController(IMediator mediator) : BaseApiCont
     [ProducesResponseType(typeof(ApiResponse<object>), StatusCodes.Status404NotFound)]
     public async Task<ApiResponse<SystemParameterDto>> Update(long parameterId, [FromBody] UpdateSystemParameterCommand command, CancellationToken cancellationToken)
     {
+        // 1. 确保命令包含参数标识
         if (command.ParameterId == 0)
         {
             command = command with { ParameterId = parameterId };
         }
 
+        // 2. 执行更新
         var result = await mediator.Send(command, cancellationToken);
+
+        // 3. 返回结果或 404
         return result == null
             ? ApiResponse<SystemParameterDto>.Error(ErrorCodes.NotFound, "系统参数不存在")
             : ApiResponse<SystemParameterDto>.Ok(result);
@@ -107,7 +119,10 @@ public sealed class SystemParametersController(IMediator mediator) : BaseApiCont
     [ProducesResponseType(typeof(ApiResponse<object>), StatusCodes.Status404NotFound)]
     public async Task<ApiResponse<object>> Delete(long parameterId, CancellationToken cancellationToken)
     {
+        // 1. 执行删除
         var success = await mediator.Send(new DeleteSystemParameterCommand { ParameterId = parameterId }, cancellationToken);
+
+        // 2. 返回成功或 404
         return success
             ? ApiResponse.Success()
             : ApiResponse<object>.Error(ErrorCodes.NotFound, "系统参数不存在");