docs: 完善参数注释与StyleCop配置

This commit is contained in:
2025-12-04 12:45:26 +08:00
parent 8e4c2b0e45
commit 37e7d721f3
213 changed files with 695 additions and 446 deletions

View File

@@ -1,6 +1,5 @@
using MediatR;
using Microsoft.AspNetCore.Authorization;
using Microsoft.AspNetCore.Http;
using Microsoft.AspNetCore.Mvc;
using TakeoutSaaS.Application.App.Deliveries.Commands;
using TakeoutSaaS.Application.App.Deliveries.Dto;
@@ -24,6 +23,9 @@ public sealed class DeliveriesController(IMediator mediator) : BaseApiController
/// <summary>
/// 创建配送单。
/// </summary>
/// <param name="command">创建命令。</param>
/// <param name="cancellationToken">取消标记。</param>
/// <returns>创建后的配送单。</returns>
[HttpPost]
[PermissionAuthorize("delivery:create")]
[ProducesResponseType(typeof(ApiResponse<DeliveryOrderDto>), StatusCodes.Status200OK)]
@@ -39,6 +41,14 @@ public sealed class DeliveriesController(IMediator mediator) : BaseApiController
/// <summary>
/// 查询配送单列表。
/// </summary>
/// <param name="orderId">订单 ID。</param>
/// <param name="status">配送状态。</param>
/// <param name="page">页码。</param>
/// <param name="pageSize">每页大小。</param>
/// <param name="sortBy">排序字段。</param>
/// <param name="sortDesc">是否倒序。</param>
/// <param name="cancellationToken">取消标记。</param>
/// <returns>配送单分页列表。</returns>
[HttpGet]
[PermissionAuthorize("delivery:read")]
[ProducesResponseType(typeof(ApiResponse<PagedResult<DeliveryOrderDto>>), StatusCodes.Status200OK)]
@@ -69,6 +79,9 @@ public sealed class DeliveriesController(IMediator mediator) : BaseApiController
/// <summary>
/// 获取配送单详情。
/// </summary>
/// <param name="deliveryOrderId">配送单 ID。</param>
/// <param name="cancellationToken">取消标记。</param>
/// <returns>配送单详情或未找到。</returns>
[HttpGet("{deliveryOrderId:long}")]
[PermissionAuthorize("delivery:read")]
[ProducesResponseType(typeof(ApiResponse<DeliveryOrderDto>), StatusCodes.Status200OK)]
@@ -87,6 +100,10 @@ public sealed class DeliveriesController(IMediator mediator) : BaseApiController
/// <summary>
/// 更新配送单。
/// </summary>
/// <param name="deliveryOrderId">配送单 ID。</param>
/// <param name="command">更新命令。</param>
/// <param name="cancellationToken">取消标记。</param>
/// <returns>更新后的配送单或未找到。</returns>
[HttpPut("{deliveryOrderId:long}")]
[PermissionAuthorize("delivery:update")]
[ProducesResponseType(typeof(ApiResponse<DeliveryOrderDto>), StatusCodes.Status200OK)]
@@ -111,6 +128,9 @@ public sealed class DeliveriesController(IMediator mediator) : BaseApiController
/// <summary>
/// 删除配送单。
/// </summary>
/// <param name="deliveryOrderId">配送单 ID。</param>
/// <param name="cancellationToken">取消标记。</param>
/// <returns>删除结果,未找到则返回错误。</returns>
[HttpDelete("{deliveryOrderId:long}")]
[PermissionAuthorize("delivery:delete")]
[ProducesResponseType(typeof(ApiResponse<object>), StatusCodes.Status200OK)]