[修改] Command 模块增加 XML 文档注释，完善命令过滤器、中间件、命令包装器和 JsonCommand 功能

Author: AlianBlank

src/GameFrameX.SuperSocket.Command/AsyncCommandFilter.cs

@@ -3,20 +3,24 @@
 
 namespace GameFrameX.SuperSocket.Command
 {
+    /// <summary>
+    /// Represents an attribute for filtering asynchronous commands.
+    /// </summary>
     [AttributeUsage(AttributeTargets.Class, AllowMultiple = true)]
     public abstract class AsyncCommandFilterAttribute : CommandFilterBaseAttribute
     {
         /// <summary>
-        /// Called when [command executing].
+        /// Called before a command is executed asynchronously.
         /// </summary>
-        /// <param name="commandContext"></param>
-        /// <returns>return if the service should continue to process this session</returns>
+        /// <param name="commandContext">The context of the command being executed.</param>
+        /// <returns>A task that represents the asynchronous operation. Returns true if the command should continue execution; otherwise, false.</returns>
         public abstract ValueTask<bool> OnCommandExecutingAsync(CommandExecutingContext commandContext);
 
         /// <summary>
-        /// Called when [command executed].
+        /// Called after a command is executed asynchronously.
         /// </summary>
-        /// <param name="commandContext">The command context.</param>
+        /// <param name="commandContext">The context of the command that was executed.</param>
+        /// <returns>A task that represents the asynchronous operation.</returns>
         public abstract ValueTask OnCommandExecutedAsync(CommandExecutingContext commandContext);
     }
 }

src/GameFrameX.SuperSocket.Command/CommandAttribute.cs

@@ -2,22 +2,43 @@
 
 namespace GameFrameX.SuperSocket.Command
 {
+    /// <summary>
+    /// Specifies metadata for a command, including its name and key.
+    /// </summary>
     [AttributeUsage(AttributeTargets.Class, AllowMultiple = false)]
     public class CommandAttribute : Attribute
     {
+        /// <summary>
+        /// Gets or sets the name of the command.
+        /// </summary>
         public string Name { get; set; }
 
+        /// <summary>
+        /// Gets or sets the key associated with the command.
+        /// </summary>
         public object Key { get; set; }
 
+        /// <summary>
+        /// Initializes a new instance of the <see cref="CommandAttribute"/> class.
+        /// </summary>
         public CommandAttribute()
         {
         }
 
+        /// <summary>
+        /// Initializes a new instance of the <see cref="CommandAttribute"/> class with the specified name.
+        /// </summary>
+        /// <param name="name">The name of the command.</param>
         public CommandAttribute(string name)
         {
             Name = name;
         }
 
+        /// <summary>
+        /// Initializes a new instance of the <see cref="CommandAttribute"/> class with the specified name and key.
+        /// </summary>
+        /// <param name="name">The name of the command.</param>
+        /// <param name="key">The key associated with the command.</param>
         public CommandAttribute(string name, object key)
             : this(name)
         {

src/GameFrameX.SuperSocket.Command/CommandExecutingContext.cs

@@ -4,6 +4,9 @@
 
 namespace GameFrameX.SuperSocket.Command
 {
+    /// <summary>
+    /// Represents the context for executing a command.
+    /// </summary>
     public struct CommandExecutingContext
     {
         /// <summary>
@@ -29,6 +32,9 @@ public struct CommandExecutingContext
         /// </value>
         public Exception Exception { get; set; }
 
+        /// <summary>
+        /// Gets the cancellation token.
+        /// </summary>
         public CancellationToken CancellationToken { get; set; }
     }
-}
+}

src/GameFrameX.SuperSocket.Command/CommandFilter.cs

@@ -2,37 +2,46 @@
 
 namespace GameFrameX.SuperSocket.Command
 {
+    /// <summary>
+    /// Defines a filter that can be applied to commands.
+    /// </summary>
     public interface ICommandFilter
     {
+        /// <summary>
+        /// Gets the execution order of the filter.
+        /// </summary>
         int Order { get; }
     }
 
+    /// <summary>
+    /// Represents a base attribute for command filters.
+    /// </summary>
     [AttributeUsage(AttributeTargets.Class, AllowMultiple = true)]
     public abstract class CommandFilterBaseAttribute : Attribute, ICommandFilter
     {
         /// <summary>
-        /// Gets or sets the execution order.
+        /// Gets or sets the execution order of the filter.
         /// </summary>
-        /// <value>
-        /// The order.
-        /// </value>
         public int Order { get; set; }
     }
 
-
+    /// <summary>
+    /// Represents an attribute for filtering commands.
+    /// </summary>
     [AttributeUsage(AttributeTargets.Class, AllowMultiple = true)]
     public abstract class CommandFilterAttribute : CommandFilterBaseAttribute
     {
         /// <summary>
-        /// Called when [command executing].
+        /// Called before a command is executed.
         /// </summary>
-        /// <param name="commandContext">The command context.</param>
+        /// <param name="commandContext">The context of the command being executed.</param>
+        /// <returns>True if the command should continue execution; otherwise, false.</returns>
         public abstract bool OnCommandExecuting(CommandExecutingContext commandContext);
 
         /// <summary>
-        /// Called when [command executed].
+        /// Called after a command is executed.
         /// </summary>
-        /// <param name="commandContext">The command context.</param>
+        /// <param name="commandContext">The context of the command that was executed.</param>
         public abstract void OnCommandExecuted(CommandExecutingContext commandContext);
     }
-}
+}

src/GameFrameX.SuperSocket.Command/CommandMetadata.cs

@@ -2,18 +2,37 @@
 
 namespace GameFrameX.SuperSocket.Command
 {
+    /// <summary>
+    /// Represents metadata for a command, including its name and key.
+    /// </summary>
     public class CommandMetadata
     {
+        /// <summary>
+        /// Gets the name of the command.
+        /// </summary>
         public string Name { get; private set; }
 
+        /// <summary>
+        /// Gets the key associated with the command.
+        /// </summary>
         public object Key { get; private set; }
 
+        /// <summary>
+        /// Initializes a new instance of the <see cref="CommandMetadata"/> class with the specified name and key.
+        /// </summary>
+        /// <param name="name">The name of the command.</param>
+        /// <param name="key">The key associated with the command.</param>
         public CommandMetadata(string name, object key)
         {
             Name = name;
             Key = key;
         }
 
+        /// <summary>
+        /// Initializes a new instance of the <see cref="CommandMetadata"/> class with the specified name.
+        /// The key is set to the same value as the name.
+        /// </summary>
+        /// <param name="name">The name of the command.</param>
         public CommandMetadata(string name)
             : this(name, name)
         {