🎨 ExplanatoryNoteFormat

docfx.json

@@ -33,13 +33,11 @@
           "toc.yml",
           "*.html",
           "*.md",
-          "api/**.yml",
-          "api/index.md",
-          "api/**/**.yml"
+          "**/**/*.{md,yml}"
         ],
         "exclude": [
           "_site/**",
-          "ref/Common/"
+          "ref/**"
         ]
       }
     ],
@@ -58,7 +56,7 @@
       "modern"
     ],
     "globalMetadata": {
-      "_appName": "SteamClient 文档",
+      "_appName": "SteamClient",
       "_appTitle": "SteamClient",
       "_appLogoPath": "res/DocFXIcon.png",
       "_appFooter": "©️ 江苏蒸汽凡星科技有限公司. All rights reserved.",

src/BD.SteamClient8.Impl/PInvoke/SteamServiceImpl.cs

@@ -3,7 +3,7 @@
 namespace BD.SteamClient8.Impl.PInvoke;
 
 /// <summary>
-/// <see cref="ISteamService"/> 类实现
+/// <see cref="ISteamService"/> Steam 相关助手、工具类服务实现
 /// </summary>
 public abstract partial class SteamServiceImpl : ISteamService
 {

src/BD.SteamClient8.Impl/PInvoke/SteamworksLocalApiServiceImpl.cs

@@ -7,7 +7,7 @@
 
 namespace BD.SteamClient8.Impl.PInvoke;
 
-/// <inheritdoc cref="ISteamworksLocalApiService "/>
+/// <inheritdoc cref="ISteamworksLocalApiService "/> Steamworks 本地 API 服务实现
 public sealed class SteamworksLocalApiServiceImpl : ISteamworksLocalApiService
 {
 #if (WINDOWS || MACCATALYST || MACOS || LINUX) && !(IOS || ANDROID)

src/BD.SteamClient8.Primitives/Enums/WebApi/PersonaState.cs

@@ -1,6 +1,8 @@
 namespace BD.SteamClient8.Primitives.Enums.WebApi;
 
-#pragma warning disable SA1600 // Elements should be documented
+/// <summary>
+/// 在线状态
+/// </summary>
 public enum PersonaState
 {
     Default = -1,

src/WinAuth/WinAuth/IAuthenticator.cs

@@ -57,7 +57,7 @@ public enum PasswordTypes
     string CurrentCode { get; }
 
     /// <summary>
-    /// 将此验证器的时间与服务器时间同步。我们用UTC时间的差值更新数据记录
+    /// 将此验证器的时间与服务器时间同步，我们用 UTC 时间的差值更新数据记录
     /// </summary>
     void Sync();
 

src/WinAuth/WinAuth/SteamAuthenticator.cs

@@ -63,7 +63,7 @@ public SteamAuthenticator() : base(CODE_DIGITS)
     public string? Serial { get; set; }
 
     /// <summary>
-    /// 创建并注册的随机设备ID
+    /// 创建并注册的随机设备 ID
     /// </summary>
     public string? DeviceId { get; set; }
 
@@ -394,7 +394,7 @@ public override string? SecretData
     /// <summary>
     /// 获取(或创建)此认证器的当前 Steam 客户端
     /// </summary>
-    /// <returns>current or new SteamClient</returns>
+    /// <returns>当前或新的 SteamClient</returns>
     public SteamClient GetClient(string? language = null)
     {
         lock (this)

src/WinAuth/WinAuth/SteamClient.cs

@@ -147,7 +147,7 @@ public static WinAuthException GetWinAuthInvalidEnrollResponseException(string r
     public sealed class ConfirmationPoller
     {
         /// <summary>
-        /// 民意调查之间的秒数
+        /// 两次轮询之间的秒数
         /// </summary>
         public int Duration { get; set; }
 
@@ -157,19 +157,19 @@ public sealed class ConfirmationPoller
         public PollerAction Action { get; set; }
 
         /// <summary>
-        /// List of current Confirmations ids
+        /// 当前确认 ID 列表
         /// </summary>
         public List<string>? Ids { get; set; }
 
         /// <summary>
-        /// Create new ConfirmationPoller object
+        /// 创建新的 ConfirmationPoller 对象
         /// </summary>
         public ConfirmationPoller()
         {
         }
 
         /// <summary>
-        /// Create a JSON string of the object
+        /// 创建对象的 JSON 字符串
         /// </summary>
         /// <returns></returns>
         public override string ToString()
@@ -393,7 +393,7 @@ public Task RefreshAccessToken(SteamClient client)
         /// <summary>
         /// 检查访问令牌是否已过期
         /// </summary>
-        /// <returns>如果访问令牌已过期，则返回true；否则返回false</returns>
+        /// <returns>如果访问令牌已过期，则返回 <see langword="true"/>；否则返回 <see langword="false"/></returns>
         public bool IsAccessTokenExpired()
         {
             if (string.IsNullOrEmpty(this.AccessToken))
@@ -403,9 +403,9 @@ public bool IsAccessTokenExpired()
         }
 
         /// <summary>
-        /// 检查刷新令牌是否已过期。
+        /// 检查刷新令牌是否已过期
         /// </summary>
-        /// <returns>如果刷新令牌已过期，则返回true；否则返回false。</returns>
+        /// <returns>如果刷新令牌已过期，则返回 <see langword="true"/>；否则返回 <see langword="false"/></returns>
         public bool IsRefreshTokenExpired()
         {
             if (string.IsNullOrEmpty(this.RefreshToken))
@@ -433,9 +433,9 @@ private bool IsTokenExpired(string token)
         }
 
         /// <summary>
-        /// 获取会话的Cookie容器。
+        /// 获取会话的 Cookie 容器
         /// </summary>
-        /// <returns>包含会话Cookie的CookieContainer对象。</returns>
+        /// <returns>包含会话 Cookie 的 CookieContainer 对象</returns>
         public CookieContainer GetCookies()
         {
             if (this.SessionID == null)
@@ -472,9 +472,9 @@ private static string GetRandomHexNumber(int digits)
         }
 
         /// <summary>
-        /// 将当前实例转换为JSON字符串。
+        /// 将当前实例转换为 JSON 字符串
         /// </summary>
-        /// <returns>包含当前实例信息的JSON字符串。</returns>
+        /// <returns>包含当前实例信息的 JSON 字符串</returns>
         public override string ToString()
         {
             return SystemTextJsonSerializer.Serialize(this);
@@ -592,7 +592,7 @@ private class GenerateAccessTokenForAppResponseResponse
     public event ConfirmationErrorDelegate? ConfirmationErrorEvent;
 
     /// <summary>
-    /// 创建一个新的SteamClient
+    /// 创建一个新的 SteamClient
     /// </summary>
     public SteamClient(SteamAuthenticator auth)
     {
@@ -609,7 +609,7 @@ public SteamClient(SteamAuthenticator auth)
     }
 
     /// <summary>
-    /// 处理对象
+    /// 释放
     /// </summary>
     public void Dispose()
     {
@@ -618,7 +618,7 @@ public void Dispose()
     }
 
     /// <summary>
-    /// 处理此对象
+    /// 释放
     /// </summary>
     /// <param name="disposing"></param>
     protected virtual void Dispose(bool disposing)