feat: translate xml document of Cnblogs.Architecture.Ddd.Cqrs.Abstractions

Author: ikesnowy

Cnblogs.Architecture.sln.DotSettings

@@ -0,0 +1,2 @@
+<wpf:ResourceDictionary xml:space="preserve" xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml" xmlns:s="clr-namespace:System;assembly=mscorlib" xmlns:ss="urn:shemas-jetbrains-com:settings-storage-xaml" xmlns:wpf="http://schemas.microsoft.com/winfx/2006/xaml/presentation">
+	<s:Boolean x:Key="/Default/UserDictionary/Words/=cachable/@EntryIndexedValue">True</s:Boolean></wpf:ResourceDictionary>

Directory.Build.props

@@ -8,6 +8,8 @@
         <Product>Cnblogs.Architecture</Product>
         <PackageProjectUrl>https://github.com/cnblogs/Architecture</PackageProjectUrl>
         <PackageLicenseExpression>MIT</PackageLicenseExpression>
+        <RepositoryUrl>https://github.com/cnblogs/Architecture</RepositoryUrl>
+        <RepositoryType>git</RepositoryType>
     </PropertyGroup>
 
     <ItemGroup>

src/Cnblogs.Architecture.Ddd.Cqrs.Abstractions/CacheBehavior.cs

@@ -1,17 +1,17 @@
 namespace Cnblogs.Architecture.Ddd.Cqrs.Abstractions;
 
 /// <summary>
-///     缓存行为定义。
+///     Options for handing <see cref="ICachableRequest"/>.
 /// </summary>
 public enum CacheBehavior
 {
     /// <summary>
-    ///     不存在时获取新的。
+    ///     Update cache after cache missed, this is the default behavior.
     /// </summary>
     UpdateCacheIfMiss = 1,
 
     /// <summary>
-    ///     不使用缓存。
+    ///     Do not cache this request.
     /// </summary>
     DisabledCache = 2
 }

src/Cnblogs.Architecture.Ddd.Cqrs.Abstractions/CacheableRequestBehavior.cs

@@ -9,12 +9,12 @@
 namespace Cnblogs.Architecture.Ddd.Cqrs.Abstractions;
 
 /// <summary>
-///     对实现了 <see cref="ICacheableRequest" /> 的请求进行处理。
+///     Handler for <see cref="ICachableRequest" />.
 /// </summary>
-/// <typeparam name="TRequest">实现了 <see cref="ICacheableRequest" /> 的请求。</typeparam>
-/// <typeparam name="TResponse"><typeparamref name="TRequest" /> 请求的结果。</typeparam>
+/// <typeparam name="TRequest">Request that implements <see cref="ICachableRequest" />.</typeparam>
+/// <typeparam name="TResponse">Cached result for <typeparamref name="TRequest" />.</typeparam>
 public class CacheableRequestBehavior<TRequest, TResponse> : IPipelineBehavior<TRequest, TResponse>
-    where TRequest : ICacheableRequest, IRequest<TResponse>
+    where TRequest : ICachableRequest, IRequest<TResponse>
 {
     private readonly IDateTimeProvider _dateTimeProvider;
     private readonly ILocalCacheProvider? _local;
@@ -23,12 +23,12 @@ public class CacheableRequestBehavior<TRequest, TResponse> : IPipelineBehavior<T
     private readonly ILogger<CacheableRequestBehavior<TRequest, TResponse>> _logger;
 
     /// <summary>
-    ///     构建一个 <see cref="CacheableRequestBehavior{TRequest,TResponse}" />。
+    ///     Create <see cref="CacheableRequestBehavior{TRequest,TResponse}" />.
     /// </summary>
-    /// <param name="providers">缓存提供器。</param>
-    /// <param name="dateTimeProvider">时间提供器。</param>
-    /// <param name="options">缓存配置项。</param>
-    /// <param name="logger">日志记录器。</param>
+    /// <param name="providers">Cache providers.</param>
+    /// <param name="dateTimeProvider">Datetime provider.</param>
+    /// <param name="options">Options for cache behavior.</param>
+    /// <param name="logger">logger.</param>
     public CacheableRequestBehavior(
         IEnumerable<ICacheProvider> providers,
         IDateTimeProvider dateTimeProvider,

src/Cnblogs.Architecture.Ddd.Cqrs.Abstractions/CacheableRequestOptions.cs

@@ -1,22 +1,22 @@
 namespace Cnblogs.Architecture.Ddd.Cqrs.Abstractions;
 
 /// <summary>
-/// 缓存配置。
+///     Options for handling <see cref="ICachableRequest"/>.
 /// </summary>
 public class CacheableRequestOptions
 {
     /// <summary>
-    /// 如果获取失败抛出异常。
+    ///     Rethrow exception if getting cached result failed.
     /// </summary>
     public bool ThrowIfFailedOnGet { get; set; }
 
     /// <summary>
-    /// 如果更新失败则抛出异常。
+    ///     Rethrow exception if updating cache failed.
     /// </summary>
     public bool ThrowIfFailedOnUpdate { get; set; }
 
     /// <summary>
-    /// 如果清除缓存失败则抛出异常，可能被 <see cref="InvalidCacheRequest"/> 中的 <see cref="InvalidCacheRequest.ThrowIfFailed"/> 覆盖。
+    ///     Rethrow exception if removing cache failed, this option can be overriden by <see cref="InvalidCacheRequest.ThrowIfFailed"/> for specific type of request.
     /// </summary>
     public bool ThrowIfFailedOnRemove { get; set; }
 }

src/Cnblogs.Architecture.Ddd.Cqrs.Abstractions/Cnblogs.Architecture.Ddd.Cqrs.Abstractions.csproj

@@ -1,13 +1,19 @@
 <Project Sdk="Microsoft.NET.Sdk">
 
-    <ItemGroup>
-        <ProjectReference Include="..\Cnblogs.Architecture.Ddd.Infrastructure.Abstractions\Cnblogs.Architecture.Ddd.Infrastructure.Abstractions.csproj" />
-    </ItemGroup>
-
-    <ItemGroup>
-        <PackageReference Include="Mapster" Version="7.3.0" />
-        <PackageReference Include="Microsoft.Extensions.Logging.Abstractions" Version="7.0.0" />
-        <PackageReference Include="Microsoft.Extensions.Options.ConfigurationExtensions" Version="7.0.0" />
-    </ItemGroup>
+  <PropertyGroup>
+    <Description>
+      Provides building blocks to archive CQRS pattern, including ICommand, IQuery, IPageableQuery, etc.
+    </Description>
+  </PropertyGroup>
+
+  <ItemGroup>
+    <ProjectReference Include="..\Cnblogs.Architecture.Ddd.Infrastructure.Abstractions\Cnblogs.Architecture.Ddd.Infrastructure.Abstractions.csproj"/>
+  </ItemGroup>
+
+  <ItemGroup>
+    <PackageReference Include="Mapster" Version="7.3.0"/>
+    <PackageReference Include="Microsoft.Extensions.Logging.Abstractions" Version="7.0.0"/>
+    <PackageReference Include="Microsoft.Extensions.Options.ConfigurationExtensions" Version="7.0.0"/>
+  </ItemGroup>
 
 </Project>

src/Cnblogs.Architecture.Ddd.Cqrs.Abstractions/CommandResponse.cs

@@ -3,23 +3,26 @@
 namespace Cnblogs.Architecture.Ddd.Cqrs.Abstractions;
 
 /// <summary>
-///     命令返回的结果。
+///     Response returned by <see cref="ICommand{TError}"/>.
 /// </summary>
 public abstract record CommandResponse : IValidationResponse, ILockableResponse
 {
     /// <summary>
-    ///     是否出现验证错误。
+    ///     Check if validation fails.
     /// </summary>
     public bool IsValidationError { get; init; }
 
     /// <summary>
-    /// 是否出现并发错误。
+    ///     Check if concurrent error happened.
     /// </summary>
     public bool IsConcurrentError { get; init; }
 
     /// <summary>
-    ///     错误信息。
+    ///     The error message returned by handler, return empty if no error or no error message.
     /// </summary>
+    /// <remarks>
+    ///     Do not rely on this property to determine if executed successful, use <see cref="IsSuccess"/> for this purpose.
+    /// </remarks>
     public string ErrorMessage { get; init; } = string.Empty;
 
     /// <inheritdoc />
@@ -29,55 +32,55 @@ public abstract record CommandResponse : IValidationResponse, ILockableResponse
     public bool LockAcquired { get; set; }
 
     /// <summary>
-    ///     执行是否成功。
+    ///     Check if command executed successfully.
     /// </summary>
-    /// <returns></returns>
+    /// <returns>Return true if executed successfully, else return false.</returns>
     public virtual bool IsSuccess()
     {
         return IsValidationError == false && string.IsNullOrEmpty(ErrorMessage) && IsConcurrentError == false;
     }
 
     /// <summary>
-    ///     获取错误信息。
+    ///     Get error message.
     /// </summary>
-    /// <returns></returns>
+    /// <returns>The error message, return <see cref="string.Empty"/> if no error.</returns>
     public virtual string GetErrorMessage() => ErrorMessage;
 }
 
 /// <summary>
-///     命令返回的结果。
+///     Response returned by <see cref="ICommand{TError}"/>.
 /// </summary>
-/// <typeparam name="TError">错误枚举类型。</typeparam>
+/// <typeparam name="TError">The enumeration presenting errors.</typeparam>
 public record CommandResponse<TError> : CommandResponse
     where TError : Enumeration
 {
     /// <summary>
-    ///     构造一个 <see cref="CommandResponse{TError}" />。
+    ///     Create a successful <see cref="CommandResponse{TError}" />.
     /// </summary>
     public CommandResponse()
     {
         ErrorCode = default;
     }
 
     /// <summary>
-    ///     构造一个 <see cref="CommandResponse{TError}" />。
+    ///     Create a <see cref="CommandResponse{TError}" /> with given error.
     /// </summary>
-    /// <param name="errorCode">错误码。</param>
+    /// <param name="errorCode">The error.</param>
     public CommandResponse(TError errorCode)
     {
         ErrorCode = errorCode;
     }
 
     /// <summary>
-    ///     错误码。
+    ///     The error returned by handler, can be null if execution succeeded.
     /// </summary>
     public TError? ErrorCode { get; set; }
 
     /// <summary>
-    ///     构造一个代表命令执行失败的 <see cref="CommandResponse{TError}" />
+    ///     Create a failed <see cref="CommandResponse{TError}" /> with given error.
     /// </summary>
-    /// <param name="errorCode">错误码。</param>
-    /// <returns>代表命令执行失败的 <see cref="CommandResponse{TError}" /></returns>
+    /// <param name="errorCode">The error.</param>
+    /// <returns>A failed <see cref="CommandResponse{TError}" /> with given error.</returns>
     public static CommandResponse<TError> Fail(TError errorCode)
     {
         return new CommandResponse<TError>(errorCode);
@@ -96,77 +99,80 @@ public override string GetErrorMessage()
     }
 
     /// <summary>
-    ///     构造一个代表命令执行成功的 <see cref="CommandResponse{TError}" />。
+    ///     Create a successful <see cref="CommandResponse{TError}" />.
     /// </summary>
-    /// <returns>代表命令执行成功的 <see cref="CommandResponse{TError}" /></returns>
+    /// <returns>A successful <see cref="CommandResponse{TError}" />.</returns>
     public static CommandResponse<TError> Success()
     {
         return new CommandResponse<TError>();
     }
 }
 
 /// <summary>
-///     命令返回的结果。
+///     Response returned by <see cref="ICommand{TError}"/>.
 /// </summary>
-/// <typeparam name="TView">命令执行成功时返回的结果类型。</typeparam>
-/// <typeparam name="TError">错误类型。</typeparam>
+/// <typeparam name="TView">The model type been returned if execution completed without error.</typeparam>
+/// <typeparam name="TError">The enumeration type representing errors.</typeparam>
 public record CommandResponse<TView, TError> : CommandResponse<TError>, IObjectResponse
     where TError : Enumeration
 {
     /// <summary>
-    ///     构造一个 <see cref="CommandResponse{TView,TError}" />。
+    ///     Create a <see cref="CommandResponse{TView,TError}" />.
     /// </summary>
     public CommandResponse()
     {
     }
 
     /// <summary>
-    ///     构造一个 <see cref="CommandResponse{TError}" />。
+    ///     Create a <see cref="CommandResponse{TError}" /> with given error.
     /// </summary>
-    /// <param name="errorCode">错误码。</param>
+    /// <param name="errorCode">The error.</param>
     public CommandResponse(TError errorCode)
         : base(errorCode)
     {
     }
 
     /// <summary>
-    ///     构造一个 <see cref="CommandResponse{TError}" />。
+    ///     Create a <see cref="CommandResponse{TError}" /> with given model.
     /// </summary>
-    /// <param name="response">命令返回结果。</param>
+    /// <param name="response">The execution result.</param>
     private CommandResponse(TView response)
     {
         Response = response;
     }
 
     /// <summary>
-    ///     命令执行结果。
+    ///     The result been returned by command handler.
     /// </summary>
+    /// <remarks>
+    ///     This property can be null even if execution completed with no error.
+    /// </remarks>
     public TView? Response { get; }
 
     /// <summary>
-    ///     构造一个代表执行失败的 <see cref="CommandResponse{TView,TError}" />。
+    ///     Create a <see cref="CommandResponse{TView,TError}" /> with given error.
     /// </summary>
-    /// <param name="errorCode">错误码。</param>
-    /// <returns></returns>
+    /// <param name="errorCode">The error.</param>
+    /// <returns>A <see cref="CommandResponse{TView, TError}"/> with given error.</returns>
     public static new CommandResponse<TView, TError> Fail(TError errorCode)
     {
         return new CommandResponse<TView, TError>(errorCode);
     }
 
     /// <summary>
-    ///     构造一个代表执行成功的 <see cref="CommandResponse{TView,TError}" />。
+    ///     Create a <see cref="CommandResponse{TView,TError}" /> with no result nor error.
     /// </summary>
-    /// <returns>代表执行成功的 <see cref="CommandResponse{TView,TError}" />。</returns>
+    /// <returns>The <see cref="CommandResponse{TView,TError}" />。</returns>
     public static new CommandResponse<TView, TError> Success()
     {
         return new CommandResponse<TView, TError>();
     }
 
     /// <summary>
-    ///     构造一个代表执行成功的 <see cref="CommandResponse{TView,TError}" />。
+    ///     Create a <see cref="CommandResponse{TView,TError}" /> with given result.
     /// </summary>
-    /// <param name="view">执行结果。</param>
-    /// <returns></returns>
+    /// <param name="view">The model to return.</param>
+    /// <returns>A <see cref="CommandResponse{TView, TError}"/> with given result.</returns>
     public static CommandResponse<TView, TError> Success(TView view)
     {
         return new CommandResponse<TView, TError>(view);

src/Cnblogs.Architecture.Ddd.Cqrs.Abstractions/ICacheableRequest.cs renamed to src/Cnblogs.Architecture.Ddd.Cqrs.Abstractions/ICachableRequest.cs

@@ -1,48 +1,48 @@
 namespace Cnblogs.Architecture.Ddd.Cqrs.Abstractions;
 
 /// <summary>
-///     定义可缓存的请求
+///     Definition for cachable request.
 /// </summary>
-public interface ICacheableRequest
+public interface ICachableRequest
 {
     /// <summary>
-    ///     本地缓存配置。
+    ///     Configuration for local cache provider.
     /// </summary>
     CacheBehavior LocalCacheBehavior { get; set; }
 
     /// <summary>
-    ///     远程缓存配置。
+    ///     Configuration for remote cache provider.
     /// </summary>
     CacheBehavior RemoteCacheBehavior { get; set; }
 
     /// <summary>
-    ///     本地缓存过期时间。
+    ///     The expire time for local cache.
     /// </summary>
     TimeSpan? LocalExpires { get; set; }
 
     /// <summary>
-    ///     远程缓存过期时间。
+    ///     The expire time for remote cache.
     /// </summary>
     TimeSpan? RemoteExpires { get; set; }
 
     /// <summary>
-    ///     获取缓存分组键，<c>null</c> 代表不分组。
+    ///     Generate key for cache group, return <c>null</c> for no group.
     /// </summary>
     /// <returns></returns>
     string? CacheGroupKey();
 
     /// <summary>
-    ///     获取缓存键。
+    ///     Generate cache key for each request.
     /// </summary>
-    /// <returns></returns>
+    /// <returns>The cache key for current request.</returns>
     string CacheKey()
     {
         return string.Join('-', GetCacheKeyParameters().Select(p => p?.ToString()?.ToLower()));
     }
 
     /// <summary>
-    ///     获取组成缓存键的参数。
+    ///     Get parameters for generating cache key, will call <see cref="object.ToString"/> to each object been provided.
     /// </summary>
-    /// <returns></returns>
+    /// <returns>The parameter array.</returns>
     object?[] GetCacheKeyParameters();
 }

src/Cnblogs.Architecture.Ddd.Cqrs.Abstractions/ICommand.Generic.cs

@@ -5,15 +5,18 @@
 namespace Cnblogs.Architecture.Ddd.Cqrs.Abstractions;
 
 /// <summary>
-///     定义 CQRS 中的命令相关的行为。
+///     Definitions of command in CQRS.
 /// </summary>
-/// <typeparam name="TView">命令执行成功时返回的结果。</typeparam>
-/// <typeparam name="TError">命令失败时返回的错误码类型。</typeparam>
+/// <typeparam name="TView">The result type for command.</typeparam>
+/// <typeparam name="TError">The error code type when command failed.</typeparam>
 public interface ICommand<TView, TError> : IRequest<CommandResponse<TView, TError>>
     where TError : Enumeration
 {
     /// <summary>
-    ///     命令是否只进行验证。
+    ///     Only execute validation logic.
     /// </summary>
+    /// <remarks>
+    ///     This logic must be implemented manually in command handler and not guaranteed by framework.
+    /// </remarks>
     public bool ValidateOnly { get; }
 }

src/Cnblogs.Architecture.Ddd.Cqrs.Abstractions/ICommand.cs

@@ -5,14 +5,17 @@
 namespace Cnblogs.Architecture.Ddd.Cqrs.Abstractions;
 
 /// <summary>
-///     定义 CQRS 中的命令相关的行为。
+///     Definition for command.
 /// </summary>
-/// <typeparam name="TError">命令失败时返回的错误码类型。</typeparam>
+/// <typeparam name="TError">The error type when command execution failed.</typeparam>
 public interface ICommand<TError> : IRequest<CommandResponse<TError>>
     where TError : Enumeration
 {
     /// <summary>
-    ///     命令是否只执行验证。
+    ///     Only execute validation logic.
     /// </summary>
+    /// <remarks>
+    ///     This logic must be implemented manually in command handler and not guaranteed by framework.
+    /// </remarks>
     public bool ValidateOnly { get; }
 }

src/Cnblogs.Architecture.Ddd.Cqrs.Abstractions/ICommandHandler.Generic.cs

@@ -5,11 +5,11 @@
 namespace Cnblogs.Architecture.Ddd.Cqrs.Abstractions;
 
 /// <summary>
-///     定义 <see cref="ICommand{TError}" /> 的实际处理逻辑。
+///     Definitions of handler that handles <see cref="ICommand{TView, TError}" />。
 /// </summary>
-/// <typeparam name="TCommand">该 Handler 能够处理的命令类型。</typeparam>
-/// <typeparam name="TView">命令返回的结果类型。</typeparam>
-/// <typeparam name="TError">该 Handler 返回的错误码类型。</typeparam>
+/// <typeparam name="TCommand">The command type for this handler.</typeparam>
+/// <typeparam name="TView">The result type for this handler.</typeparam>
+/// <typeparam name="TError">The error type for this handler.</typeparam>
 public interface ICommandHandler<TCommand, TView, TError> : IRequestHandler<TCommand, CommandResponse<TView, TError>>
     where TCommand : ICommand<TView, TError>
     where TError : Enumeration

src/Cnblogs.Architecture.Ddd.Cqrs.Abstractions/ICommandHandler.cs

@@ -5,10 +5,10 @@
 namespace Cnblogs.Architecture.Ddd.Cqrs.Abstractions;
 
 /// <summary>
-///     定义 <see cref="ICommand{TError}" /> 的实际处理逻辑。
+///     Definitions of handler that handles <see cref="ICommand{TError}" />.
 /// </summary>
-/// <typeparam name="TCommand">该 Handler 能够处理的命令类型。</typeparam>
-/// <typeparam name="TError">该 Handler 返回的错误码类型。</typeparam>
+/// <typeparam name="TCommand">The command type for this handler.</typeparam>
+/// <typeparam name="TError">The error type for this handler.</typeparam>
 public interface ICommandHandler<TCommand, TError> : IRequestHandler<TCommand, CommandResponse<TError>>
     where TCommand : ICommand<TError>
     where TError : Enumeration

src/Cnblogs.Architecture.Ddd.Cqrs.Abstractions/IConfigurableLockableRequest.cs

@@ -1,12 +1,12 @@
 namespace Cnblogs.Architecture.Ddd.Cqrs.Abstractions;
 
 /// <summary>
-///     可配置的分布式锁请求。
+///     Definitions of a <see cref="ILockableRequest"/> with some configurations.
 /// </summary>
 public interface IConfigurableLockableRequest : ILockableRequest
 {
     /// <summary>
-    ///     锁过期时间。
+    ///     The maximum waiting time for requiring a lock.
     /// </summary>
     TimeSpan ExpiresIn { get; }
 }

src/Cnblogs.Architecture.Ddd.Cqrs.Abstractions/IDomainEventHandler.cs

@@ -5,9 +5,9 @@
 namespace Cnblogs.Architecture.Ddd.Cqrs.Abstractions;
 
 /// <summary>
-///     领域事件处理器。
+///     Definitions of handler for <see cref="DomainEvent"/>.
 /// </summary>
-/// <typeparam name="TDomainEvent">要订阅的领域事件。</typeparam>
+/// <typeparam name="TDomainEvent">The domain event type for this handler to handle.</typeparam>
 public interface IDomainEventHandler<TDomainEvent> : INotificationHandler<TDomainEvent>
     where TDomainEvent : DomainEvent
 {

src/Cnblogs.Architecture.Ddd.Cqrs.Abstractions/IListQuery.cs

@@ -3,9 +3,9 @@
 namespace Cnblogs.Architecture.Ddd.Cqrs.Abstractions;
 
 /// <summary>
-///     定义返回多个结果的查询。
+///     Represents a query returns a list of items.
 /// </summary>
-/// <typeparam name="TList">查询结果类型，通常是一个列表类型。</typeparam>
+/// <typeparam name="TList">The list to return, usually a <see cref="List{T}"/>.</typeparam>
 public interface IListQuery<TList> : IRequest<TList>
 {
 }

src/Cnblogs.Architecture.Ddd.Cqrs.Abstractions/IListQueryHandler.cs

@@ -3,10 +3,10 @@
 namespace Cnblogs.Architecture.Ddd.Cqrs.Abstractions;
 
 /// <summary>
-///     定义 <see cref="IListQuery{TList}" /> 的处理逻辑。
+///     Represents a handler for <see cref="IListQuery{TList}" />.
 /// </summary>
-/// <typeparam name="TQuery">该 Handler 能够处理的 <see cref="IListQuery{TList}" /> 类型。</typeparam>
-/// <typeparam name="TList">查询结果类型。</typeparam>
+/// <typeparam name="TQuery">The <see cref="IListQuery{TList}" /> been handled.</typeparam>
+/// <typeparam name="TList">The result type of <typeparamref name="TQuery"/>.</typeparam>
 public interface IListQueryHandler<TQuery, TList> : IRequestHandler<TQuery, TList>
     where TQuery : IListQuery<TList>
 {

src/Cnblogs.Architecture.Ddd.Cqrs.Abstractions/ILockableRequest.cs

@@ -1,13 +1,13 @@
 namespace Cnblogs.Architecture.Ddd.Cqrs.Abstractions;
 
 /// <summary>
-///     定义需要分布式锁的请求
+///     Represents a request that needs distributed locks.
 /// </summary>
 public interface ILockableRequest
 {
     /// <summary>
-    ///   获取锁的 Key。
+    ///     Get the key of distributed lock.
     /// </summary>
-    /// <returns></returns>
+    /// <returns>The key of distributed lock.</returns>
     string GetLockKey();
 }

src/Cnblogs.Architecture.Ddd.Cqrs.Abstractions/ILockableResponse.cs

@@ -1,17 +1,17 @@
 namespace Cnblogs.Architecture.Ddd.Cqrs.Abstractions;
 
 /// <summary>
-///     使用分布式锁后的响应。
+///     Represents response for <see cref="ILockableRequest"/>.
 /// </summary>
 public interface ILockableResponse
 {
     /// <summary>
-    /// 是否出现并发错误（获取不到锁）
+    ///     Indicates whether lock was required successfully.
     /// </summary>
     bool IsConcurrentError { get; init; }
 
     /// <summary>
-    ///     是否成功获取到锁。
+    ///    Indicates whether lock was required.
     /// </summary>
     bool LockAcquired { get; set; }
 }

src/Cnblogs.Architecture.Ddd.Cqrs.Abstractions/IObjectResponse.cs

@@ -1,13 +1,13 @@
 namespace Cnblogs.Architecture.Ddd.Cqrs.Abstractions;
 
 /// <summary>
-///     包含结果对象的响应。
+///     Represents response that contains object result.
 /// </summary>
 public interface IObjectResponse
 {
     /// <summary>
-    ///     获取结果。
+    ///     Get object result.
     /// </summary>
-    /// <returns>结果。</returns>
+    /// <returns>The resulting object.</returns>
     public object? GetResult();
 }

src/Cnblogs.Architecture.Ddd.Cqrs.Abstractions/IOrderedQuery.cs

@@ -1,13 +1,14 @@
 namespace Cnblogs.Architecture.Ddd.Cqrs.Abstractions;
 
 /// <summary>
-///     定义返回已排序的多个结果的查询。
+///     Represents a <see cref="IListQuery{TList}"/> with ordered results.
 /// </summary>
-/// <typeparam name="TList">查询结果类型，通常是列表类型。</typeparam>
+/// <typeparam name="TList">The querying type, usually a list type.</typeparam>
 public interface IOrderedQuery<TList> : IListQuery<TList>
 {
     /// <summary>
-    ///     排序字符串。
+    ///     The string indicates the order.
     /// </summary>
+    /// <example>Order by string can be like "-dateadded"(order by dateadded desc) or "id"(order by id asc).</example>
     string? OrderByString { get; }
 }

src/Cnblogs.Architecture.Ddd.Cqrs.Abstractions/IPageableQuery.cs

@@ -3,13 +3,13 @@
 namespace Cnblogs.Architecture.Ddd.Cqrs.Abstractions;
 
 /// <summary>
-///     定义返回分页结果的查询类型。
+///     Represents a <see cref="IOrderedQuery{TList}"/> with paged results.
 /// </summary>
-/// <typeparam name="TElement">单个查询结果的类型。</typeparam>
+/// <typeparam name="TElement">The type for each item in results.</typeparam>
 public interface IPageableQuery<TElement> : IOrderedQuery<PagedList<TElement>>
 {
     /// <summary>
-    ///     分页参数。
+    ///     The paging parameters, include page index and page size.
     /// </summary>
     PagingParams? PagingParams { get; }
 }

src/Cnblogs.Architecture.Ddd.Cqrs.Abstractions/IPageableQueryHandler.cs

@@ -3,10 +3,10 @@
 namespace Cnblogs.Architecture.Ddd.Cqrs.Abstractions;
 
 /// <summary>
-///     定义处理分页查询的逻辑。
+///     Represents the handler for <see cref="IPageableQuery{TElement}" />.
 /// </summary>
-/// <typeparam name="TQuery">查询类型，需要继承 <see cref="IPageableQuery{TElement}" />。</typeparam>
-/// <typeparam name="TView">单个查询结果类型，将返回 IPagedList&lt;TView&gt;。</typeparam>
+/// <typeparam name="TQuery">The <see cref="IPageableQuery{TElement}" /> to handle.</typeparam>
+/// <typeparam name="TView">The type for each item in <see cref="PagedList{T}"/>.</typeparam>
 public interface IPageableQueryHandler<TQuery, TView> : IListQueryHandler<TQuery, PagedList<TView>>
     where TQuery : IPageableQuery<TView>
 {

src/Cnblogs.Architecture.Ddd.Cqrs.Abstractions/IQuery.cs

@@ -3,9 +3,9 @@
 namespace Cnblogs.Architecture.Ddd.Cqrs.Abstractions;
 
 /// <summary>
-///     定义获取单个结果的查询。
+///     Represents query for single item.
 /// </summary>
-/// <typeparam name="TView">结果类型。</typeparam>
+/// <typeparam name="TView">The type of item to query.</typeparam>
 public interface IQuery<TView> : IRequest<TView?>
 {
 }

src/Cnblogs.Architecture.Ddd.Cqrs.Abstractions/IQueryHandler.cs

@@ -3,10 +3,10 @@
 namespace Cnblogs.Architecture.Ddd.Cqrs.Abstractions;
 
 /// <summary>
-///     定义处理 <see cref="IQuery{TView}" /> 的逻辑。
+///     Represents handler that handles <see cref="IQuery{TView}"/>.
 /// </summary>
-/// <typeparam name="TQuery">查询类型，需要继承 <see cref="IQuery{TView}" />。</typeparam>
-/// <typeparam name="TView">结果类型。</typeparam>
+/// <typeparam name="TQuery">The <see cref="IQuery{TView}" /> type to handle.</typeparam>
+/// <typeparam name="TView">The type of item to query.</typeparam>
 public interface IQueryHandler<TQuery, TView> : IRequestHandler<TQuery, TView?>
     where TQuery : IQuery<TView>
 {

src/Cnblogs.Architecture.Ddd.Cqrs.Abstractions/IValidatable.cs

@@ -1,12 +1,12 @@
 namespace Cnblogs.Architecture.Ddd.Cqrs.Abstractions;
 
 /// <summary>
-///     定义可验证的类型。
+///     Represents a request that can be validated.
 /// </summary>
 public interface IValidatable
 {
     /// <summary>
-    ///     验证方法，出错时返回 <see cref="ValidationError"/>，否则返回 <code>null</code>。
+    ///     Validate the object, return <see cref="ValidationError"/> if fails or <code>null</code> if passed.
     /// </summary>
     ValidationError? Validate();
 }

src/Cnblogs.Architecture.Ddd.Cqrs.Abstractions/IValidationResponse.cs

@@ -1,22 +1,22 @@
 namespace Cnblogs.Architecture.Ddd.Cqrs.Abstractions;
 
 /// <summary>
-///     <see cref="IValidatable" /> 的返回类型。
+///     Represents response for <see cref="IValidatable" />.
 /// </summary>
 public interface IValidationResponse
 {
     /// <summary>
-    ///     验证是否失败。
+    ///     Indicates whether validation is failed.
     /// </summary>
     bool IsValidationError { get; init; }
 
     /// <summary>
-    ///     错误信息。
+    ///     Contain error message if validation fails.
     /// </summary>
     string ErrorMessage { get; init; }
 
     /// <summary>
-    /// 错误信息对象。
+    ///     The validation results, null if validation was passed.
     /// </summary>
     ValidationError? ValidationError { get; init; }
 }

src/Cnblogs.Architecture.Ddd.Cqrs.Abstractions/InvalidCacheRequest.cs

@@ -3,9 +3,12 @@
 namespace Cnblogs.Architecture.Ddd.Cqrs.Abstractions;
 
 /// <summary>
-///     清除缓存请求。
+///     Represents request to invalid caches.
 /// </summary>
+/// <param name="Request">The request that been cached.</param>
+/// <param name="InvalidWholeGroup">Invalid cache for the group that <paramref name="Request"/> was in.</param>
+/// <param name="ThrowIfFailed">Throw exceptions if fails, overrides same options in <see cref="CacheableRequestOptions"/>.</param>
 public record InvalidCacheRequest(
-    ICacheableRequest Request,
+    ICachableRequest Request,
     bool InvalidWholeGroup = false,
     bool? ThrowIfFailed = null) : IRequest;

src/Cnblogs.Architecture.Ddd.Cqrs.Abstractions/InvalidCacheRequestHandler.cs

@@ -9,7 +9,7 @@
 namespace Cnblogs.Architecture.Ddd.Cqrs.Abstractions;
 
 /// <summary>
-///     清除缓存。
+///     The default handler for <see cref="InvalidCacheRequest"/>.
 /// </summary>
 public class InvalidCacheRequestHandler : IRequestHandler<InvalidCacheRequest>
 {
@@ -20,12 +20,12 @@ public class InvalidCacheRequestHandler : IRequestHandler<InvalidCacheRequest>
     private readonly ILogger<InvalidCacheRequestHandler> _logger;
 
     /// <summary>
-    ///     构建一个 <see cref="CacheableRequestBehavior{TRequest,TResponse}" />。
+    ///     Create a <see cref="CacheableRequestBehavior{TRequest,TResponse}" />.
     /// </summary>
-    /// <param name="providers">缓存提供器。</param>
-    /// <param name="dateTimeProvider">时间提供器。</param>
-    /// <param name="options">缓存配置。</param>
-    /// <param name="logger">日志记录器。</param>
+    /// <param name="providers">Cache providers.</param>
+    /// <param name="dateTimeProvider">Datetime providers.</param>
+    /// <param name="options">Cache options.</param>
+    /// <param name="logger">log provider.</param>
     public InvalidCacheRequestHandler(
         IEnumerable<ICacheProvider> providers,
         IDateTimeProvider dateTimeProvider,

src/Cnblogs.Architecture.Ddd.Cqrs.Abstractions/LockableRequestBehavior.cs

@@ -7,10 +7,10 @@
 namespace Cnblogs.Architecture.Ddd.Cqrs.Abstractions;
 
 /// <summary>
-///     处理需要分布式锁的请求。
+///     Handle requests that require distributed lock.
 /// </summary>
-/// <typeparam name="TRequest">请求类型。</typeparam>
-/// <typeparam name="TResponse">响应类型。</typeparam>
+/// <typeparam name="TRequest">The type of request.</typeparam>
+/// <typeparam name="TResponse">The type of response.</typeparam>
 public class LockableRequestBehavior<TRequest, TResponse> : IPipelineBehavior<TRequest, TResponse>
     where TRequest : ILockableRequest, IRequest<TResponse>
     where TResponse : ILockableResponse, new()
@@ -19,10 +19,10 @@ public class LockableRequestBehavior<TRequest, TResponse> : IPipelineBehavior<TR
     private readonly ILogger<LockableRequestBehavior<TRequest, TResponse>> _logger;
 
     /// <summary>
-    ///     创建一个新的 <see cref="LockableRequestBehavior{TRequest, TResponse}" /> 实例。
+    ///     Create a new <see cref="LockableRequestBehavior{TRequest, TResponse}" /> instance.
     /// </summary>
-    /// <param name="distributedLockProvider">分布式锁提供器。</param>
-    /// <param name="logger">日志记录器。</param>
+    /// <param name="distributedLockProvider">Distributed lock provider.</param>
+    /// <param name="logger">log provider.</param>
     public LockableRequestBehavior(
         IDistributedLockProvider distributedLockProvider,
         ILogger<LockableRequestBehavior<TRequest, TResponse>> logger)

src/Cnblogs.Architecture.Ddd.Cqrs.Abstractions/LoggingBehavior.cs

@@ -5,19 +5,19 @@
 namespace Cnblogs.Architecture.Ddd.Cqrs.Abstractions;
 
 /// <summary>
-///     记录命令/查询日志
+///     Middleware for logging requests and events.
 /// </summary>
-/// <typeparam name="TRequest">请求类型。</typeparam>
-/// <typeparam name="TResponse">返回类型。</typeparam>
+/// <typeparam name="TRequest">The type of request.</typeparam>
+/// <typeparam name="TResponse">The type of response.</typeparam>
 public class LoggingBehavior<TRequest, TResponse> : IPipelineBehavior<TRequest, TResponse>
     where TRequest : IRequest<TResponse>
 {
     private readonly ILogger<LoggingBehavior<TRequest, TResponse>> _logger;
 
     /// <summary>
-    ///     新建一个 <see cref="LoggingBehavior{TRequest, TResponse}" /> 类型的实例。
+    ///     Create a new <see cref="LoggingBehavior{TRequest, TResponse}" /> instance.
     /// </summary>
-    /// <param name="logger">日志记录器。</param>
+    /// <param name="logger">Log provider.</param>
     public LoggingBehavior(ILogger<LoggingBehavior<TRequest, TResponse>> logger)
     {
         _logger = logger;

src/Cnblogs.Architecture.Ddd.Cqrs.Abstractions/PageableQueryHandlerBase.cs

@@ -5,11 +5,11 @@
 namespace Cnblogs.Architecture.Ddd.Cqrs.Abstractions;
 
 /// <summary>
-///     用于实现 <see cref="IPageableQueryHandler{TQuery,TView}" /> 的基类。
+///     Base class for implementing <see cref="IPageableQueryHandler{TQuery,TView}" />.
 /// </summary>
-/// <typeparam name="TQuery">查询类型。</typeparam>
-/// <typeparam name="TEntity">实体类型。</typeparam>
-/// <typeparam name="TView">返回类型。</typeparam>
+/// <typeparam name="TQuery">The type of query.</typeparam>
+/// <typeparam name="TEntity">The type of entity to query.</typeparam>
+/// <typeparam name="TView">The type of projected view model.</typeparam>
 public abstract class PageableQueryHandlerBase<TQuery, TEntity, TView> : IPageableQueryHandler<TQuery, TView>
     where TQuery : IPageableQuery<TView>
 {
@@ -45,54 +45,54 @@ public async Task<PagedList<TView>> Handle(TQuery request, CancellationToken can
     }
 
     /// <summary>
-    ///     获取总数的查询。
+    ///     Query for total count.
     /// </summary>
-    /// <param name="query">查询条件。</param>
-    /// <param name="queryable">过滤好的 <see cref="IQueryable{T}" />。</param>
-    /// <returns>总数。</returns>
+    /// <param name="query">The query parameters.</param>
+    /// <param name="queryable">Filtered <see cref="IQueryable{T}" />.</param>
+    /// <returns>The total count of items.</returns>
     protected abstract Task<int> CountAsync(TQuery query, IQueryable<TEntity> queryable);
 
     /// <summary>
-    ///     默认的排序条件，如果没有指定 <see cref="OrderBySegment" />，将会使用这一语句。
+    ///     The default order by field, used when <see cref="OrderBySegment" /> is not present.
     /// </summary>
-    /// <param name="query">查询条件。</param>
-    /// <param name="queryable"><see cref="Filter" />返回的<see cref="IQueryable{TEntity}" />。</param>
-    /// <returns>排序好的 <see cref="IQueryable{T}" />。</returns>
+    /// <param name="query">The query parameters.</param>
+    /// <param name="queryable"><see cref="IQueryable{TEntity}" /> returned by <see cref="Filter" />.</param>
+    /// <returns>Ordered <see cref="IQueryable{T}" />.</returns>
     protected abstract IQueryable<TEntity> DefaultOrderBy(TQuery query, IQueryable<TEntity> queryable);
 
     /// <summary>
-    ///     获取并过滤，返回 <see cref="IQueryable{T}" />
+    ///     Create queryable and apply filter, return filtered <see cref="IQueryable{T}" />.
     /// </summary>
-    /// <param name="query">输入的查询条件。</param>
-    /// <returns>过滤后的 <see cref="IQueryable{T}" />。</returns>
+    /// <param name="query">The query parameter.</param>
+    /// <returns>Filtered <see cref="IQueryable{T}" />.</returns>
     protected abstract IQueryable<TEntity> Filter(TQuery query);
 
     /// <summary>
-    ///     获取并过滤，返回 <see cref="IQueryable{T}" />
+    ///     Create queryable and apply filter asynchronously, return filtered <see cref="IQueryable{T}" />.
     /// </summary>
-    /// <param name="query">输入的查询条件。</param>
-    /// <returns>过滤后的 <see cref="IQueryable{T}" />。</returns>
+    /// <param name="query">The query parameter.</param>
+    /// <returns>Filtered <see cref="IQueryable{T}" />.</returns>
     protected virtual Task<IQueryable<TEntity>> FilterAsync(TQuery query)
     {
         return Task.FromResult(Filter(query));
     }
 
     /// <summary>
-    ///     投射结果，返回 <see cref="IQueryable{TView}" />。
+    ///     Project item to view model, return projected <see cref="IQueryable{TView}" />.
     /// </summary>
-    /// <param name="query">查询条件。</param>
-    /// <param name="queryable">过滤并排序完成的 <see cref="IQueryable{T}" />。</param>
-    /// <returns>投射好的 <see cref="IQueryable" />。</returns>
+    /// <param name="query">The query parameter.</param>
+    /// <param name="queryable">Filtered and ordered <see cref="IQueryable{T}" />.</param>
+    /// <returns>Projected <see cref="IQueryable" />.</returns>
     protected virtual IQueryable<TView> ProjectToView(TQuery query, IQueryable<TEntity> queryable)
     {
         return queryable.ProjectToType<TView>();
     }
 
     /// <summary>
-    ///     执行实际的查询。
+    ///     Execute query and projections, get the actual results.
     /// </summary>
-    /// <param name="query">查询条件。</param>
-    /// <param name="queryable">投射好的 <see cref="IQueryable{T}" /></param>
-    /// <returns>查询结果。</returns>
+    /// <param name="query">The query parameter.</param>
+    /// <param name="queryable">Projected <see cref="IQueryable{T}" />.</param>
+    /// <returns>The query result.</returns>
     protected abstract Task<List<TView>> ToListAsync(TQuery query, IQueryable<TView> queryable);
 }

src/Cnblogs.Architecture.Ddd.Cqrs.Abstractions/ValidationBehavior.cs

@@ -5,20 +5,20 @@
 namespace Cnblogs.Architecture.Ddd.Cqrs.Abstractions;
 
 /// <summary>
-///     对实现了 <see cref="IValidatable" /> 的 <see cref="IRequest" /> 进行验证。
+///     Validate requests that implements <see cref="IValidatable" />.
 /// </summary>
-/// <typeparam name="TRequest">请求类型。</typeparam>
-/// <typeparam name="TResponse">结果类型。</typeparam>
+/// <typeparam name="TRequest">The type of request.</typeparam>
+/// <typeparam name="TResponse">The type of response.</typeparam>
 public class ValidationBehavior<TRequest, TResponse> : IPipelineBehavior<TRequest, TResponse>
     where TRequest : IValidatable, IRequest<TResponse>
     where TResponse : IValidationResponse, new()
 {
     private readonly ILogger<ValidationBehavior<TRequest, TResponse>> _logger;
 
     /// <summary>
-    ///     构造一个 <see cref="ValidationBehavior{TRequest,TResponse}" />。
+    ///     Create a new <see cref="ValidationBehavior{TRequest,TResponse}" />.
     /// </summary>
-    /// <param name="logger"></param>
+    /// <param name="logger">The log provider.</param>
     public ValidationBehavior(ILogger<ValidationBehavior<TRequest, TResponse>> logger)
     {
         _logger = logger;

src/Cnblogs.Architecture.Ddd.Cqrs.Abstractions/ValidationError.cs

@@ -1,8 +1,8 @@
 namespace Cnblogs.Architecture.Ddd.Cqrs.Abstractions;
 
 /// <summary>
-/// 验证错误。
+///     A Validation error returned by <see cref="IValidatable"/>.
 /// </summary>
-/// <param name="Message">错误信息。</param>
-/// <param name="ParameterName">参数名称。</param>
+/// <param name="Message">The error message.</param>
+/// <param name="ParameterName">The parameter name that failed to validate.</param>
 public record ValidationError(string Message, string? ParameterName);

src/Cnblogs.Architecture.Ddd.Cqrs.DependencyInjection/CqrsInjector.cs

@@ -65,7 +65,7 @@ public CqrsInjector AddDistributionLock<TDistributedLockProvider>()
     }
 
     /// <summary>
-    ///     启用缓存中间件，自动处理和缓存实现了 <see cref="ICacheableRequest" /> 接口的请求。
+    ///     启用缓存中间件，自动处理和缓存实现了 <see cref="ICachableRequest" /> 接口的请求。
     /// </summary>
     /// <typeparam name="TLocal">本地缓存提供器。</typeparam>
     /// <param name="configure">缓存配置。</param>
@@ -79,7 +79,7 @@ public CqrsInjector AddLocalQueryCache<TLocal>(Action<CacheableRequestOptions>?
     }
 
     /// <summary>
-    ///     启用缓存中间件，自动处理和缓存实现了 <see cref="ICacheableRequest" /> 接口的请求。
+    ///     启用缓存中间件，自动处理和缓存实现了 <see cref="ICachableRequest" /> 接口的请求。
     /// </summary>
     /// <typeparam name="TLocal">本地缓存提供器。</typeparam>
     /// <typeparam name="TRemote">远程缓存提供器。</typeparam>
@@ -96,7 +96,7 @@ public CqrsInjector AddQueryCache<TLocal, TRemote>(Action<CacheableRequestOption
     }
 
     /// <summary>
-    ///     启用缓存中间件，自动处理和缓存实现了 <see cref="ICacheableRequest" /> 接口的请求。
+    ///     启用缓存中间件，自动处理和缓存实现了 <see cref="ICachableRequest" /> 接口的请求。
     /// </summary>
     /// <typeparam name="TRemote">远程缓存提供器。</typeparam>
     /// <param name="configure">缓存配置。</param>

src/Directory.Build.props

@@ -4,6 +4,16 @@
 
     <PropertyGroup>
         <GenerateDocumentationFile>true</GenerateDocumentationFile>
+        <PublishRepositoryUrl>true</PublishRepositoryUrl>
+        <IncludeSymbols>true</IncludeSymbols>
+        <SymbolPackageFormat>snupkg</SymbolPackageFormat>
+        <PackageReleaseNotes>
+            Please check release notes at: https://github.com/cnblogs/Architecture/releases
+        </PackageReleaseNotes>
     </PropertyGroup>
+    
+    <ItemGroup>
+        <PackageReference Include="Microsoft.SourceLink.GitHub" Version="1.1.1" PrivateAssets="All"/>
+    </ItemGroup>
 
 </Project>

test/Cnblogs.Architecture.IntegrationTests/DaprTests.cs

@@ -10,10 +10,6 @@ namespace Cnblogs.Architecture.IntegrationTests;
 
 public class DaprTests
 {
-    public DaprTests()
-    {
-    }
-
     [Fact]
     public async Task Dapr_SubscribeEndpoint_OkAsync()
     {

test/Cnblogs.Architecture.UnitTests/Cqrs/Behaviors/CacheBehaviorTests.cs

@@ -251,7 +251,7 @@ public void CacheBehavior_NoProvider_Throw()
     private static CacheableRequestBehavior<TRequest, TResponse> GetBehavior<TRequest, TResponse>(
         List<ICacheProvider> providers,
         Action<CacheableRequestOptions>? optionConfigure = null)
-        where TRequest : ICacheableRequest, IRequest<TResponse>
+        where TRequest : ICachableRequest, IRequest<TResponse>
     {
         var option = new CacheableRequestOptions();
         optionConfigure?.Invoke(option);

test/Cnblogs.Architecture.UnitTests/Cqrs/FakeObjects/FakeQuery.cs

@@ -4,7 +4,7 @@
 
 namespace Cnblogs.Architecture.UnitTests.Cqrs.FakeObjects;
 
-public class FakeQuery<TResponse> : ICacheableRequest, IRequest<TResponse>, IValidatable
+public class FakeQuery<TResponse> : ICachableRequest, IRequest<TResponse>, IValidatable
 {
     private readonly string? _cacheGroupKey;
     private readonly string _cacheKey;