一、代码添加注释说明

/// <summary>
    /// 报名信息审核相关接口
    /// </summary>
    [Route("api/[controller]/[action]")]
    [ApiController]
    public class AuditController : ControllerBase
    {
        private readonly ITalentDomainService talentDomainService;

        public AuditController(ITalentDomainService talentDomainService)
        {
            this.talentDomainService = talentDomainService;
        }

        /// <summary>
        /// 获取报名人员数据
        /// </summary>
        /// <remarks>
        /// 描述：审核模块报名数据
        /// </remarks>
        /// <param name="name"></param>
        /// <returns></returns>
        [HttpPost]
        [Authorize]
        public async Task<ActionResult<UserResponse>> GetTalentBase(string name)
        {
            return new JsonResult(await talentDomainService.GetTalentBaseList());
        }
    }
}

二、注释信息在Swagger中展示配置

这时候需要用到XML文档，因为它是通过XML来维护Swagger文档的一些信息。双击项目名称，进入如下配置页面

<GenerateDocumentationFile>true</GenerateDocumentationFile>
<NoWarn>$(NoWarn);1591</NoWarn>

在【Program.cs】文件中的【ConfigureService】类中注册读取XML信息的Swagger。

    #region 读取xml信息
    // 使用反射获取xml文件，并构造出文件的路径
    var xmlFile = $"{Assembly.GetExecutingAssembly().GetName().Name}.xml";
    var xmlPath = Path.Combine(AppContext.BaseDirectory, xmlFile);
    // 启用xml注释，该方法第二个参数启用控制器的注释，默认为false.
    c.IncludeXmlComments(xmlPath, true);
    #endregion

运行程序页面显示如下：