增加注释:添加所有类注释,移除xml警告信息
This commit is contained in:
parent
32bd9d2aa3
commit
81fce99357
|
@ -5,11 +5,14 @@ using System.Collections.Generic;
|
||||||
|
|
||||||
namespace Bootstrap.Admin.Controllers.Api
|
namespace Bootstrap.Admin.Controllers.Api
|
||||||
{
|
{
|
||||||
|
/// <summary>
|
||||||
|
/// 数据字典分类
|
||||||
|
/// </summary>
|
||||||
[Route("api/[controller]")]
|
[Route("api/[controller]")]
|
||||||
public class CategoryController : Controller
|
public class CategoryController : Controller
|
||||||
{
|
{
|
||||||
/// <summary>
|
/// <summary>
|
||||||
///
|
/// 获取字典表中所有Category数据
|
||||||
/// </summary>
|
/// </summary>
|
||||||
/// <returns></returns>
|
/// <returns></returns>
|
||||||
[HttpGet]
|
[HttpGet]
|
||||||
|
|
|
@ -67,9 +67,14 @@ namespace Bootstrap.Admin.Controllers.Api
|
||||||
}
|
}
|
||||||
return new JsonResult(sb.ToString());
|
return new JsonResult(sb.ToString());
|
||||||
}
|
}
|
||||||
|
/// <summary>
|
||||||
|
///
|
||||||
|
/// </summary>
|
||||||
public class ExceptionFileQuery
|
public class ExceptionFileQuery
|
||||||
{
|
{
|
||||||
|
/// <summary>
|
||||||
|
///
|
||||||
|
/// </summary>
|
||||||
public string FileName { get; set; }
|
public string FileName { get; set; }
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
|
@ -32,7 +32,11 @@ namespace Bootstrap.Admin.Controllers.Api
|
||||||
{
|
{
|
||||||
return LogHelper.RetrieveLogs().FirstOrDefault(t => t.Id == id);
|
return LogHelper.RetrieveLogs().FirstOrDefault(t => t.Id == id);
|
||||||
}
|
}
|
||||||
|
/// <summary>
|
||||||
|
///
|
||||||
|
/// </summary>
|
||||||
|
/// <param name="value"></param>
|
||||||
|
/// <returns></returns>
|
||||||
[HttpPost]
|
[HttpPost]
|
||||||
public bool Post([FromBody]Log value)
|
public bool Post([FromBody]Log value)
|
||||||
{
|
{
|
||||||
|
|
|
@ -14,6 +14,12 @@ namespace Bootstrap.Admin.Controllers.Api
|
||||||
[Route("api/[controller]")]
|
[Route("api/[controller]")]
|
||||||
public class ProfilesController : Controller
|
public class ProfilesController : Controller
|
||||||
{
|
{
|
||||||
|
/// <summary>
|
||||||
|
///
|
||||||
|
/// </summary>
|
||||||
|
/// <param name="env"></param>
|
||||||
|
/// <param name="files"></param>
|
||||||
|
/// <returns></returns>
|
||||||
[HttpPost]
|
[HttpPost]
|
||||||
public async Task<JsonResult> Post([FromServices]IHostingEnvironment env, IFormCollection files)
|
public async Task<JsonResult> Post([FromServices]IHostingEnvironment env, IFormCollection files)
|
||||||
{
|
{
|
||||||
|
|
|
@ -8,6 +8,9 @@ using System.Threading.Tasks;
|
||||||
|
|
||||||
namespace Bootstrap.Admin.Controllers.Api
|
namespace Bootstrap.Admin.Controllers.Api
|
||||||
{
|
{
|
||||||
|
/// <summary>
|
||||||
|
/// 注册用户操作类
|
||||||
|
/// </summary>
|
||||||
[AllowAnonymous]
|
[AllowAnonymous]
|
||||||
[Route("api/[controller]")]
|
[Route("api/[controller]")]
|
||||||
public class RegisterController : Controller
|
public class RegisterController : Controller
|
||||||
|
@ -15,7 +18,7 @@ namespace Bootstrap.Admin.Controllers.Api
|
||||||
/// <summary>
|
/// <summary>
|
||||||
/// 登录页面注册新用户remote validate调用
|
/// 登录页面注册新用户remote validate调用
|
||||||
/// </summary>
|
/// </summary>
|
||||||
/// <param name="value"></param>
|
/// <param name="userName"></param>
|
||||||
/// <returns></returns>
|
/// <returns></returns>
|
||||||
[HttpGet]
|
[HttpGet]
|
||||||
public bool Get(string userName)
|
public bool Get(string userName)
|
||||||
|
@ -25,6 +28,7 @@ namespace Bootstrap.Admin.Controllers.Api
|
||||||
/// <summary>
|
/// <summary>
|
||||||
/// 登录页面注册新用户提交按钮调用
|
/// 登录页面注册新用户提交按钮调用
|
||||||
/// </summary>
|
/// </summary>
|
||||||
|
/// <param name="hub"></param>
|
||||||
/// <param name="user"></param>
|
/// <param name="user"></param>
|
||||||
/// <returns></returns>
|
/// <returns></returns>
|
||||||
[HttpPost]
|
[HttpPost]
|
||||||
|
|
|
@ -26,7 +26,6 @@ namespace Bootstrap.Admin.Controllers.Api
|
||||||
/// <summary>
|
/// <summary>
|
||||||
///
|
///
|
||||||
/// </summary>
|
/// </summary>
|
||||||
/// <param name="value"></param>
|
|
||||||
[HttpGet]
|
[HttpGet]
|
||||||
public IEnumerable<ICacheCorsItem> Get()
|
public IEnumerable<ICacheCorsItem> Get()
|
||||||
{
|
{
|
||||||
|
|
|
@ -8,6 +8,10 @@ namespace Bootstrap.Admin.Models
|
||||||
/// </summary>
|
/// </summary>
|
||||||
public class HeaderBarModel : ModelBase
|
public class HeaderBarModel : ModelBase
|
||||||
{
|
{
|
||||||
|
/// <summary>
|
||||||
|
///
|
||||||
|
/// </summary>
|
||||||
|
/// <param name="identity"></param>
|
||||||
public HeaderBarModel(IIdentity identity)
|
public HeaderBarModel(IIdentity identity)
|
||||||
{
|
{
|
||||||
var user = UserHelper.RetrieveUserByUserName(identity.Name);
|
var user = UserHelper.RetrieveUserByUserName(identity.Name);
|
||||||
|
@ -16,6 +20,9 @@ namespace Bootstrap.Admin.Models
|
||||||
UserName = user.UserName;
|
UserName = user.UserName;
|
||||||
if (!string.IsNullOrEmpty(user.Css)) Theme = user.Css;
|
if (!string.IsNullOrEmpty(user.Css)) Theme = user.Css;
|
||||||
}
|
}
|
||||||
|
/// <summary>
|
||||||
|
///
|
||||||
|
/// </summary>
|
||||||
public string UserName { get; }
|
public string UserName { get; }
|
||||||
/// <summary>
|
/// <summary>
|
||||||
///
|
///
|
||||||
|
|
|
@ -5,8 +5,15 @@ using System.Collections.Generic;
|
||||||
|
|
||||||
namespace Bootstrap.Admin.Models
|
namespace Bootstrap.Admin.Models
|
||||||
{
|
{
|
||||||
|
/// <summary>
|
||||||
|
///
|
||||||
|
/// </summary>
|
||||||
public class NavigatorBarModel : HeaderBarModel
|
public class NavigatorBarModel : HeaderBarModel
|
||||||
{
|
{
|
||||||
|
/// <summary>
|
||||||
|
///
|
||||||
|
/// </summary>
|
||||||
|
/// <param name="controller"></param>
|
||||||
public NavigatorBarModel(ControllerBase controller) : base(controller.User.Identity)
|
public NavigatorBarModel(ControllerBase controller) : base(controller.User.Identity)
|
||||||
{
|
{
|
||||||
Navigations = MenuHelper.RetrieveSystemMenus(UserName, $"~{controller.HttpContext.Request.Path}");
|
Navigations = MenuHelper.RetrieveSystemMenus(UserName, $"~{controller.HttpContext.Request.Path}");
|
||||||
|
|
|
@ -3,13 +3,24 @@ using Microsoft.AspNetCore.Hosting;
|
||||||
|
|
||||||
namespace Bootstrap.Admin
|
namespace Bootstrap.Admin
|
||||||
{
|
{
|
||||||
|
/// <summary>
|
||||||
|
///
|
||||||
|
/// </summary>
|
||||||
public class Program
|
public class Program
|
||||||
{
|
{
|
||||||
|
/// <summary>
|
||||||
|
///
|
||||||
|
/// </summary>
|
||||||
|
/// <param name="args"></param>
|
||||||
public static void Main(string[] args)
|
public static void Main(string[] args)
|
||||||
{
|
{
|
||||||
CreateWebHostBuilder(args).Build().Run();
|
CreateWebHostBuilder(args).Build().Run();
|
||||||
}
|
}
|
||||||
|
/// <summary>
|
||||||
|
///
|
||||||
|
/// </summary>
|
||||||
|
/// <param name="args"></param>
|
||||||
|
/// <returns></returns>
|
||||||
public static IWebHostBuilder CreateWebHostBuilder(string[] args) =>
|
public static IWebHostBuilder CreateWebHostBuilder(string[] args) =>
|
||||||
WebHost.CreateDefaultBuilder(args).UseStartup<Startup>();
|
WebHost.CreateDefaultBuilder(args).UseStartup<Startup>();
|
||||||
}
|
}
|
||||||
|
|
|
@ -5,6 +5,9 @@ using System.Linq;
|
||||||
|
|
||||||
namespace Bootstrap.Admin.Query
|
namespace Bootstrap.Admin.Query
|
||||||
{
|
{
|
||||||
|
/// <summary>
|
||||||
|
///
|
||||||
|
/// </summary>
|
||||||
public class QueryDictOption : PaginationOption
|
public class QueryDictOption : PaginationOption
|
||||||
{
|
{
|
||||||
/// <summary>
|
/// <summary>
|
||||||
|
|
|
@ -5,6 +5,9 @@ using System.Linq;
|
||||||
|
|
||||||
namespace Bootstrap.Admin.Query
|
namespace Bootstrap.Admin.Query
|
||||||
{
|
{
|
||||||
|
/// <summary>
|
||||||
|
///
|
||||||
|
/// </summary>
|
||||||
public class QueryExceptionOption : PaginationOption
|
public class QueryExceptionOption : PaginationOption
|
||||||
{
|
{
|
||||||
/// <summary>
|
/// <summary>
|
||||||
|
|
|
@ -4,6 +4,9 @@ using System.Linq;
|
||||||
|
|
||||||
namespace Bootstrap.Admin.Query
|
namespace Bootstrap.Admin.Query
|
||||||
{
|
{
|
||||||
|
/// <summary>
|
||||||
|
///
|
||||||
|
/// </summary>
|
||||||
public class QueryGroupOption : PaginationOption
|
public class QueryGroupOption : PaginationOption
|
||||||
{
|
{
|
||||||
/// <summary>
|
/// <summary>
|
||||||
|
|
|
@ -5,6 +5,9 @@ using System.Linq;
|
||||||
|
|
||||||
namespace Bootstrap.Admin.Query
|
namespace Bootstrap.Admin.Query
|
||||||
{
|
{
|
||||||
|
/// <summary>
|
||||||
|
///
|
||||||
|
/// </summary>
|
||||||
public class QueryLogOption : PaginationOption
|
public class QueryLogOption : PaginationOption
|
||||||
{
|
{
|
||||||
/// <summary>
|
/// <summary>
|
||||||
|
|
|
@ -5,6 +5,9 @@ using System.Linq;
|
||||||
|
|
||||||
namespace Bootstrap.Admin.Query
|
namespace Bootstrap.Admin.Query
|
||||||
{
|
{
|
||||||
|
/// <summary>
|
||||||
|
///
|
||||||
|
/// </summary>
|
||||||
public class QueryMenuOption : PaginationOption
|
public class QueryMenuOption : PaginationOption
|
||||||
{
|
{
|
||||||
/// <summary>
|
/// <summary>
|
||||||
|
@ -23,7 +26,11 @@ namespace Bootstrap.Admin.Query
|
||||||
///
|
///
|
||||||
/// </summary>
|
/// </summary>
|
||||||
public string IsResource { get; set; }
|
public string IsResource { get; set; }
|
||||||
|
/// <summary>
|
||||||
|
///
|
||||||
|
/// </summary>
|
||||||
|
/// <param name="userName"></param>
|
||||||
|
/// <returns></returns>
|
||||||
public QueryData<BootstrapMenu> RetrieveData(string userName)
|
public QueryData<BootstrapMenu> RetrieveData(string userName)
|
||||||
{
|
{
|
||||||
var data = MenuHelper.RetrieveMenusByUserName(userName);
|
var data = MenuHelper.RetrieveMenusByUserName(userName);
|
||||||
|
|
|
@ -4,6 +4,9 @@ using System.Linq;
|
||||||
|
|
||||||
namespace Bootstrap.Admin.Query
|
namespace Bootstrap.Admin.Query
|
||||||
{
|
{
|
||||||
|
/// <summary>
|
||||||
|
///
|
||||||
|
/// </summary>
|
||||||
public class QueryRoleOption : PaginationOption
|
public class QueryRoleOption : PaginationOption
|
||||||
{
|
{
|
||||||
/// <summary>
|
/// <summary>
|
||||||
|
|
|
@ -17,7 +17,10 @@ namespace Bootstrap.Admin.Query
|
||||||
///
|
///
|
||||||
/// </summary>
|
/// </summary>
|
||||||
public string DisplayName { get; set; }
|
public string DisplayName { get; set; }
|
||||||
|
/// <summary>
|
||||||
|
///
|
||||||
|
/// </summary>
|
||||||
|
/// <returns></returns>
|
||||||
public QueryData<User> RetrieveData()
|
public QueryData<User> RetrieveData()
|
||||||
{
|
{
|
||||||
// int limit, int offset, string name, string price, string sort, string order
|
// int limit, int offset, string name, string price, string sort, string order
|
||||||
|
|
|
@ -14,13 +14,13 @@ namespace Bootstrap.Admin
|
||||||
///
|
///
|
||||||
/// </summary>
|
/// </summary>
|
||||||
/// <param name="client"></param>
|
/// <param name="client"></param>
|
||||||
/// <param name="message"></param>
|
/// <param name="args"></param>
|
||||||
/// <returns></returns>
|
/// <returns></returns>
|
||||||
public static async System.Threading.Tasks.Task Send(IClientProxy client, MessageBody args) => await client.SendAsync("rev", args);
|
public static async System.Threading.Tasks.Task Send(IClientProxy client, MessageBody args) => await client.SendAsync("rev", args);
|
||||||
/// <summary>
|
/// <summary>
|
||||||
///
|
///
|
||||||
/// </summary>
|
/// </summary>
|
||||||
/// <param name="client"></param>
|
/// <param name="context"></param>
|
||||||
/// <param name="ex"></param>
|
/// <param name="ex"></param>
|
||||||
/// <returns></returns>
|
/// <returns></returns>
|
||||||
public static async System.Threading.Tasks.Task Send<T>(IHubContext<T> context, Exception ex) where T : Hub
|
public static async System.Threading.Tasks.Task Send<T>(IHubContext<T> context, Exception ex) where T : Hub
|
||||||
|
|
Loading…
Reference in New Issue