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

@@ -21,6 +21,9 @@ public sealed class DictionaryController(IDictionaryAppService dictionaryAppServ
/// <summary>
/// 查询字典分组。
/// </summary>
/// <param name="query">分组查询条件。</param>
/// <param name="cancellationToken">取消标记。</param>
/// <returns>分组列表。</returns>
[HttpGet]
[PermissionAuthorize("dictionary:group:read")]
[ProducesResponseType(typeof(ApiResponse<IReadOnlyList<DictionaryGroupDto>>), StatusCodes.Status200OK)]
@@ -36,6 +39,9 @@ public sealed class DictionaryController(IDictionaryAppService dictionaryAppServ
/// <summary>
/// 创建字典分组。
/// </summary>
/// <param name="request">创建分组请求。</param>
/// <param name="cancellationToken">取消标记。</param>
/// <returns>创建后的分组。</returns>
[HttpPost]
[PermissionAuthorize("dictionary:group:create")]
[ProducesResponseType(typeof(ApiResponse<DictionaryGroupDto>), StatusCodes.Status200OK)]
@@ -51,6 +57,10 @@ public sealed class DictionaryController(IDictionaryAppService dictionaryAppServ
/// <summary>
/// 更新字典分组。
/// </summary>
/// <param name="groupId">分组 ID。</param>
/// <param name="request">更新请求。</param>
/// <param name="cancellationToken">取消标记。</param>
/// <returns>更新后的分组。</returns>
[HttpPut("{groupId:long}")]
[PermissionAuthorize("dictionary:group:update")]
[ProducesResponseType(typeof(ApiResponse<DictionaryGroupDto>), StatusCodes.Status200OK)]
@@ -66,6 +76,9 @@ public sealed class DictionaryController(IDictionaryAppService dictionaryAppServ
/// <summary>
/// 删除字典分组。
/// </summary>
/// <param name="groupId">分组 ID。</param>
/// <param name="cancellationToken">取消标记。</param>
/// <returns>操作结果。</returns>
[HttpDelete("{groupId:long}")]
[PermissionAuthorize("dictionary:group:delete")]
[ProducesResponseType(typeof(ApiResponse<object>), StatusCodes.Status200OK)]
@@ -81,6 +94,10 @@ public sealed class DictionaryController(IDictionaryAppService dictionaryAppServ
/// <summary>
/// 创建字典项。
/// </summary>
/// <param name="groupId">分组 ID。</param>
/// <param name="request">创建请求。</param>
/// <param name="cancellationToken">取消标记。</param>
/// <returns>创建的字典项。</returns>
[HttpPost("{groupId:long}/items")]
[PermissionAuthorize("dictionary:item:create")]
[ProducesResponseType(typeof(ApiResponse<DictionaryItemDto>), StatusCodes.Status200OK)]
@@ -97,6 +114,10 @@ public sealed class DictionaryController(IDictionaryAppService dictionaryAppServ
/// <summary>
/// 更新字典项。
/// </summary>
/// <param name="itemId">字典项 ID。</param>
/// <param name="request">更新请求。</param>
/// <param name="cancellationToken">取消标记。</param>
/// <returns>更新后的字典项。</returns>
[HttpPut("items/{itemId:long}")]
[PermissionAuthorize("dictionary:item:update")]
[ProducesResponseType(typeof(ApiResponse<DictionaryItemDto>), StatusCodes.Status200OK)]
@@ -112,6 +133,9 @@ public sealed class DictionaryController(IDictionaryAppService dictionaryAppServ
/// <summary>
/// 删除字典项。
/// </summary>
/// <param name="itemId">字典项 ID。</param>
/// <param name="cancellationToken">取消标记。</param>
/// <returns>操作结果。</returns>
[HttpDelete("items/{itemId:long}")]
[PermissionAuthorize("dictionary:item:delete")]
[ProducesResponseType(typeof(ApiResponse<object>), StatusCodes.Status200OK)]
@@ -127,6 +151,9 @@ public sealed class DictionaryController(IDictionaryAppService dictionaryAppServ
/// <summary>
/// 批量获取字典项(命中缓存)。
/// </summary>
/// <param name="request">批量查询请求。</param>
/// <param name="cancellationToken">取消标记。</param>
/// <returns>分组编码到字典项列表的映射。</returns>
[HttpPost("batch")]
[ProducesResponseType(typeof(ApiResponse<IReadOnlyDictionary<string, IReadOnlyList<DictionaryItemDto>>>), StatusCodes.Status200OK)]
public async Task<ApiResponse<IReadOnlyDictionary<string, IReadOnlyList<DictionaryItemDto>>>> BatchGet([FromBody] DictionaryBatchQueryRequest request, CancellationToken cancellationToken)