加上注释

src/LightWorkFlowManager/Contexts/IWorkerContext.cs

@@ -2,14 +2,39 @@
 
 namespace DC.LightWorkFlowManager.Contexts;
 
+/// <summary>
+/// 工作器上下文信息
+/// </summary>
+/// 上下文信息是带有数据的，基本上只和当前的工作过程有关的数据。和依赖注入的服务是两个不同的方向，这里的上下文信息更多的是保存一些和当前正在工作的过程有关的数据，多个不同的任务的数据不互通，相互是分开的
 public interface IWorkerContext
 {
+    /// <summary>
+    /// 获取上下文信息
+    /// </summary>
+    /// <typeparam name="T"></typeparam>
+    /// <returns>如果获取不到，返回空</returns>
     T? GetContext<T>();
+
+    /// <summary>
+    /// 设置上下文信息
+    /// </summary>
+    /// <typeparam name="T"></typeparam>
+    /// <param name="context"></param>
     void SetContext<T>(T context);
 }
 
+/// <summary>
+/// 工作器上下文信息扩展类型
+/// </summary>
 public static class MessageContextExtension
 {
+    /// <summary>
+    /// 获取一定存在的上下文信息
+    /// </summary>
+    /// <typeparam name="T"></typeparam>
+    /// <param name="workerContext"></param>
+    /// <returns></returns>
+    /// <exception cref="WorkerContextNotFoundException">如果上下文信息不存在，就抛出异常</exception>
     public static T GetEnsureContext<T>(this IWorkerContext workerContext)
     {
         var context = workerContext.GetContext<T>();

src/LightWorkFlowManager/Contexts/WorkFlowErrorCode.cs

@@ -30,8 +30,16 @@ public WorkFlowErrorCode(int code, string message)
     /// </summary>
     public string Message { get; }
 
+    /// <summary>
+    /// 表示成功
+    /// </summary>
     public static WorkFlowErrorCode Ok => new WorkFlowErrorCode(0, "Ok");
 
+    /// <summary>
+    /// 追加信息
+    /// </summary>
+    /// <param name="appendMessage"></param>
+    /// <returns></returns>
     public WorkFlowErrorCode AppendMessage(string? appendMessage)
     {
         if (appendMessage == null)
@@ -44,11 +52,19 @@ public WorkFlowErrorCode AppendMessage(string? appendMessage)
         }
     }
 
+    /// <summary>
+    /// 隐式转换为 int 类型
+    /// </summary>
+    /// <param name="code"></param>
     public static implicit operator int(WorkFlowErrorCode code)
     {
         return code.Code;
     }
 
+    /// <summary>
+    /// 从 int 类型隐式转换为错误信息
+    /// </summary>
+    /// <param name="code"></param>
     public static implicit operator WorkFlowErrorCode(int code)
     {
         if (ErrorCodeDictionary.TryGetValue(code, out var value))
@@ -64,31 +80,47 @@ public static implicit operator WorkFlowErrorCode(int code)
         return new WorkFlowErrorCode(code, string.Empty);
     }
 
+    /// <inheritdoc />
     public override string ToString() => $"{Code} {Message}";
 
     private static readonly ConcurrentDictionary<int, WorkFlowErrorCode> ErrorCodeDictionary =
         new ConcurrentDictionary<int, WorkFlowErrorCode>();
 
+    /// <inheritdoc />
     public bool Equals(WorkFlowErrorCode other)
     {
         return Code == other.Code;
     }
 
+    /// <inheritdoc />
     public override bool Equals(object? obj)
     {
         return obj is WorkFlowErrorCode other && Equals(other);
     }
 
+    /// <inheritdoc />
     public override int GetHashCode()
     {
         return Code;
     }
 
+    /// <summary>
+    /// 判断相等
+    /// </summary>
+    /// <param name="left"></param>
+    /// <param name="right"></param>
+    /// <returns></returns>
     public static bool operator ==(WorkFlowErrorCode left, WorkFlowErrorCode right)
     {
         return left.Equals(right);
     }
 
+    /// <summary>
+    /// 判断不相等
+    /// </summary>
+    /// <param name="left"></param>
+    /// <param name="right"></param>
+    /// <returns></returns>
     public static bool operator !=(WorkFlowErrorCode left, WorkFlowErrorCode right)
     {
         return !left.Equals(right);

src/LightWorkFlowManager/Exceptions/IWorkFlowException.cs

@@ -1,5 +1,8 @@
 namespace DC.LightWorkFlowManager.Exceptions;
 
+/// <summary>
+/// 表示当前是一个工作过程的异常
+/// </summary>
 public interface IWorkFlowException
 {
 }