doc: 格式化文档

This commit is contained in:
Argo-Tianyi 2021-12-30 13:31:40 +08:00
parent eea8838963
commit 39aa8bfd1d
28 changed files with 1150 additions and 1176 deletions

View File

@ -1,8 +1,8 @@
using BootstrapAdmin.DataAccess.Models;
using Microsoft.EntityFrameworkCore;
namespace BootstrapAdmin.DataAccess.EFCore
{
namespace BootstrapAdmin.DataAccess.EFCore;
/// <summary>
///
/// </summary>
@ -47,4 +47,3 @@ namespace BootstrapAdmin.DataAccess.EFCore
modelBuilder.Entity<User>().Ignore(u => u.IsReset);
}
}
}

View File

@ -4,8 +4,8 @@ using BootstrapAdmin.Web.Core;
using BootstrapBlazor.Components;
using Microsoft.EntityFrameworkCore;
namespace Microsoft.Extensions.DependencyInjection
{
namespace Microsoft.Extensions.DependencyInjection;
/// <summary>
///
/// </summary>
@ -50,4 +50,3 @@ namespace Microsoft.Extensions.DependencyInjection
return services;
}
}
}

View File

@ -5,8 +5,8 @@
using BootstrapBlazor.Components;
using Microsoft.EntityFrameworkCore;
namespace BootstrapAdmin.DataAccess.EFCore.Services
{
namespace BootstrapAdmin.DataAccess.EFCore.Services;
/// <summary>
/// EFCore ORM 的 IDataService 接口实现
/// </summary>
@ -92,4 +92,3 @@ namespace BootstrapAdmin.DataAccess.EFCore.Services
return Task.FromResult(ret);
}
}
}

View File

@ -2,8 +2,8 @@
using BootstrapAdmin.Web.Core;
using BootstrapBlazor.Components;
namespace BootstrapAdmin.DataAccess.EFCore.Services
{
namespace BootstrapAdmin.DataAccess.EFCore.Services;
class DictService : IDict
{
public Dictionary<string, string> GetApps()
@ -51,4 +51,3 @@ namespace BootstrapAdmin.DataAccess.EFCore.Services
throw new NotImplementedException();
}
}
}

View File

@ -2,8 +2,8 @@
using BootstrapAdmin.DataAccess.Models;
using Microsoft.EntityFrameworkCore;
namespace BootstrapAdmin.DataAccess.EFCore.Services
{
namespace BootstrapAdmin.DataAccess.EFCore.Services;
/// <summary>
///
/// </summary>
@ -39,4 +39,3 @@ namespace BootstrapAdmin.DataAccess.EFCore.Services
throw new NotImplementedException();
}
}
}

View File

@ -1,7 +1,7 @@
using System.ComponentModel;
namespace BootstrapAdmin.DataAccess.Models
{
namespace BootstrapAdmin.DataAccess.Models;
/// <summary>
/// 后台数据库脚本执行日志实体类
/// </summary>
@ -30,4 +30,3 @@ namespace BootstrapAdmin.DataAccess.Models
[DisplayName("执行时间")]
public DateTime LogTime { get; set; }
}
}

View File

@ -2,8 +2,8 @@
using System.ComponentModel.DataAnnotations;
namespace BootstrapAdmin.DataAccess.Models
{
namespace BootstrapAdmin.DataAccess.Models;
/// <summary>
/// 字典配置项
/// </summary>
@ -41,4 +41,3 @@ namespace BootstrapAdmin.DataAccess.Models
[Display(Name = "字典类型")]
public EnumDictDefine Define { get; set; } = EnumDictDefine.Customer;
}
}

View File

@ -1,7 +1,7 @@
using System.ComponentModel;
namespace BootstrapAdmin.DataAccess.Models
{
namespace BootstrapAdmin.DataAccess.Models;
/// <summary>
/// 字典定义值 0 表示系统使用1 表示用户自定义 默认为 1
/// </summary>
@ -19,4 +19,3 @@ namespace BootstrapAdmin.DataAccess.Models
[Description("自定义")]
Customer
}
}

View File

@ -1,7 +1,7 @@
using System.ComponentModel;
namespace BootstrapAdmin.DataAccess.Models
{
namespace BootstrapAdmin.DataAccess.Models;
/// <summary>
/// 菜单分类 0 表示系统菜单 1 表示用户自定义菜单
/// </summary>
@ -19,4 +19,3 @@ namespace BootstrapAdmin.DataAccess.Models
[Description("自定义")]
Customer
}
}

View File

@ -1,7 +1,7 @@
using System.ComponentModel;
namespace BootstrapAdmin.DataAccess.Models
{
namespace BootstrapAdmin.DataAccess.Models;
/// <summary>
/// 资源类型枚举 0 表示菜单 1 表示资源 2 表示按钮
/// </summary>
@ -23,4 +23,3 @@ namespace BootstrapAdmin.DataAccess.Models
[Description("代码块")]
Block
}
}

View File

@ -1,7 +1,7 @@
using System.ComponentModel.DataAnnotations;
namespace BootstrapAdmin.DataAccess.Models
{
namespace BootstrapAdmin.DataAccess.Models;
/// <summary>
/// Group 实体类
/// </summary>
@ -34,4 +34,3 @@ namespace BootstrapAdmin.DataAccess.Models
public override string ToString() => $"{GroupName} ({GroupCode})";
}
}

View File

@ -1,7 +1,7 @@
using System.ComponentModel;
namespace Bootstrap.DataAccess
{
namespace Bootstrap.DataAccess;
/// <summary>
/// 登录用户信息实体类
/// </summary>
@ -60,4 +60,3 @@ namespace Bootstrap.DataAccess
[DisplayName("登录名称")]
public string UserAgent { get; set; } = "";
}
}

View File

@ -2,8 +2,8 @@
using System.ComponentModel.DataAnnotations;
namespace BootstrapAdmin.DataAccess.Models
{
namespace BootstrapAdmin.DataAccess.Models;
/// <summary>
/// Bootstrap Admin 后台管理菜单相关操作实体类
/// </summary>
@ -74,4 +74,3 @@ namespace BootstrapAdmin.DataAccess.Models
/// </summary>
public bool HasChildren { get; set; }
}
}

View File

@ -1,8 +1,8 @@
using System.ComponentModel;
using System.ComponentModel.DataAnnotations;
namespace BootstrapAdmin.DataAccess.Models
{
namespace BootstrapAdmin.DataAccess.Models;
/// <summary>
/// Role 实体类
/// </summary>
@ -27,4 +27,3 @@ namespace BootstrapAdmin.DataAccess.Models
[NotNull]
public string? Description { get; set; }
}
}

View File

@ -1,7 +1,7 @@
using System.ComponentModel.DataAnnotations;
namespace BootstrapAdmin.DataAccess.Models
{
namespace BootstrapAdmin.DataAccess.Models;
/// <summary>
///
/// </summary>
@ -149,4 +149,3 @@ namespace BootstrapAdmin.DataAccess.Models
/// </summary>
SaveApp
}
}

View File

@ -1,13 +1,14 @@
<Project Sdk="Microsoft.NET.Sdk">
<ItemGroup>
<PackageReference Include="BootstrapBlazor" Version="6.1.1" />
<!--<PackageReference Include="BootstrapBlazor" Version="6.1.1" />-->
<PackageReference Include="Longbow.Security.Cryptography" Version="5.2.0" />
<PackageReference Include="Microsoft.Data.Sqlite" Version="6.0.0" />
<PackageReference Include="PetaPoco.Extensions" Version="5.2.0" />
</ItemGroup>
<ItemGroup>
<ProjectReference Include="..\..\..\..\..\BootstrapBlazor\src\BootstrapBlazor\BootstrapBlazor.csproj" />
<ProjectReference Include="..\BootstrapAdmin.Web.Core\BootstrapAdmin.Web.Core.csproj" />
</ItemGroup>

View File

@ -2,8 +2,8 @@
using PetaPoco;
using System.Reflection;
namespace BootstrapAdmin.DataAccess.PetaPoco
{
namespace BootstrapAdmin.DataAccess.PetaPoco;
class BootstrapAdminConventionMapper : ConventionMapper
{
/// <summary>
@ -71,4 +71,3 @@ namespace BootstrapAdmin.DataAccess.PetaPoco
? new StringToEnumConverter(targetProperty.PropertyType).ConvertToDb
: base.GetToDbConverter(targetProperty);
}
}

View File

@ -1,5 +1,5 @@
namespace BootstrapAdmin.DataAccess.PetaPoco.Coverters
{
namespace BootstrapAdmin.DataAccess.PetaPoco.Coverters;
/// <summary>
/// 字符串转枚举转换器
/// </summary>
@ -56,4 +56,3 @@
return ret;
}
}
}

View File

@ -7,8 +7,8 @@ using PetaPoco;
using System.Linq.Expressions;
using System.Reflection;
namespace BootstrapAdmin.Web.Extensions
{
namespace BootstrapAdmin.Web.Extensions;
/// <summary>
///
/// </summary>
@ -179,4 +179,3 @@ namespace BootstrapAdmin.Web.Extensions
_ => ""
};
}
}

View File

@ -14,8 +14,8 @@ using System.Collections.Specialized;
using System.Data.Common;
using System.Text;
namespace Microsoft.Extensions.DependencyInjection
{
namespace Microsoft.Extensions.DependencyInjection;
/// <summary>
///
/// </summary>
@ -76,4 +76,3 @@ namespace Microsoft.Extensions.DependencyInjection
return services;
}
}
}

View File

@ -1,7 +1,7 @@
using PetaPoco;
namespace BootstrapAdmin.DataAccess.PetaPoco.Services
{
namespace BootstrapAdmin.DataAccess.PetaPoco.Services;
abstract class BaseDatabase
{
/// <summary>
@ -10,4 +10,3 @@ namespace BootstrapAdmin.DataAccess.PetaPoco.Services
[NotNull]
protected IDatabase? Database { get; set; }
}
}

View File

@ -7,8 +7,8 @@ using BootstrapBlazor.Components;
using PetaPoco;
using PetaPoco.Extensions;
namespace BootstrapBlazor.DataAcces.PetaPoco.Services
{
namespace BootstrapBlazor.DataAcces.PetaPoco.Services;
/// <summary>
/// PetaPoco ORM 的 IDataService 接口实现
/// </summary>
@ -83,4 +83,3 @@ namespace BootstrapBlazor.DataAcces.PetaPoco.Services
return ret;
}
}
}

View File

@ -5,8 +5,8 @@ using System.Linq;
using System.Text;
using System.Threading.Tasks;
namespace BootstrapAdmin.DataAccess.PetaPoco.Services
{
namespace BootstrapAdmin.DataAccess.PetaPoco.Services;
class LoginService : ILogin
{
/// <summary>
@ -21,4 +21,3 @@ namespace BootstrapAdmin.DataAccess.PetaPoco.Services
return Task.FromResult(true);
}
}
}

View File

@ -2,8 +2,8 @@
using BootstrapAdmin.Web.Core;
using PetaPoco;
namespace BootstrapAdmin.DataAccess.PetaPoco.Services
{
namespace BootstrapAdmin.DataAccess.PetaPoco.Services;
/// <summary>
///
/// </summary>
@ -58,4 +58,3 @@ namespace BootstrapAdmin.DataAccess.PetaPoco.Services
return ret;
}
}
}

View File

@ -1,8 +1,8 @@
using Bootstrap.Security.Blazor;
using BootstrapAdmin.Web.Core;
namespace BootstrapAdmin.Web.Services
{
namespace BootstrapAdmin.Web.Services;
/// <summary>
///
/// </summary>
@ -54,4 +54,3 @@ namespace BootstrapAdmin.Web.Services
return Task.FromResult(ret);
}
}
}

View File

@ -1,5 +1,5 @@
namespace BootstrapAdmin.Web.Core
{
namespace BootstrapAdmin.Web.Core;
/// <summary>
/// Dict 字典表接口
/// </summary>
@ -61,4 +61,3 @@
/// <returns></returns>
string GetWebFooter();
}
}

View File

@ -1,5 +1,5 @@
namespace BootstrapAdmin.Web.Core
{
namespace BootstrapAdmin.Web.Core;
/// <summary>
///
/// </summary>
@ -13,4 +13,3 @@
/// <returns></returns>
Task<bool> Log(string userName, bool result);
}
}

View File

@ -1,7 +1,7 @@
using BootstrapAdmin.DataAccess.Models;
namespace BootstrapAdmin.Web.Core
{
namespace BootstrapAdmin.Web.Core;
/// <summary>
///
/// </summary>
@ -27,4 +27,3 @@ namespace BootstrapAdmin.Web.Core
/// <returns></returns>
bool SaveMenusByRoleId(string? roleId, List<string> menuIds);
}
}