更新 備註

Author: ozakboy

ozakboy.NLOG/ozakboy.NLOG/Configurations/LogConfiguration.cs

@@ -5,16 +5,36 @@
 namespace ozakboy.NLOG
 {
     /// <summary>
-    /// LOG配置類別
+    /// LOG配置類別 - 提供日誌系統的全局配置管理
+    /// Log Configuration Class - Provides global configuration management for the logging system
     /// </summary>
     public static class LogConfiguration
     {
-
+        /// <summary>
+        /// 儲存當前的日誌配置選項
+        /// Stores the current logging configuration options
+        /// </summary>
         private static readonly LogOptions _currentOptions = new LogOptions();
+        /// <summary>
+        /// 標記日誌系統是否已經初始化
+        /// Flag indicating whether the logging system has been initialized
+        /// </summary>
         private static bool _isInitialized = false;
+        /// <summary>
+        /// 取得日誌系統當前的配置
+        /// Gets the current configuration of the logging system
+        /// </summary>
         public static ILogOptions Current => new ReadOnlyLogOptions(_currentOptions);
+        /// <summary>
+        /// 日誌配置選項介面 - 定義可供外部讀取的配置項目
+        /// Log Options Interface - Defines configuration items available for external reading
+        /// </summary>
         public interface ILogOptions
         {
+            /// <summary>
+            /// 日誌保留天數 - 定義日誌檔案的保存期限
+            /// Log Retention Days - Defines how long log files are kept
+            /// </summary>
             int KeepDays { get; }
             long MaxFileSize { get; }
             string LogPath { get; }

ozakboy.NLOG/ozakboy.NLOG/Core/AsyncLogHandler.cs

@@ -6,26 +6,34 @@
 namespace ozakboy.NLOG.Core
 {
     /// <summary>
-    /// 異步日誌處理器，負責管理日誌的異步寫入操作
+    /// 異步日誌處理器 - 負責管理日誌的異步寫入操作，提供高效能的日誌處理機制
+    /// Asynchronous Log Handler - Manages asynchronous log writing operations, providing high-performance logging mechanism
     /// </summary>
     internal static class AsyncLogHandler
     {
         // 核心變數
         /// <summary>
-        /// 日誌隊列，用於存儲待處理的日誌項目
-        /// 使用 ConcurrentQueue 確保線程安全的入隊和出隊操作
+        /// 日誌隊列 - 用於存儲待處理的日誌項目
+        /// Log Queue - Stores pending log items for processing
         /// </summary>
+        /// <remarks>
+        /// 使用 ConcurrentQueue 確保線程安全的入隊和出隊操作
+        /// Uses ConcurrentQueue to ensure thread-safe enqueue and dequeue operations
+        /// </remarks>
         private static readonly ConcurrentQueue<LogItem> _logQueue = new ConcurrentQueue<LogItem>();
 
         /// <summary>
-        /// 信號量，用於通知處理線程有新的日誌需要處理
+        /// 信號量，用於通知處理執行緒有新的日誌需要處理
         /// 初始計數為0，每當有新日誌加入時會釋放一個信號
+        /// Semaphore for notifying the processing thread of new logs
+        /// Initial count is 0, releases a signal when new logs are added
         /// </summary>
+
         private static readonly SemaphoreSlim _signal = new SemaphoreSlim(0);
 
         /// <summary>
-        /// 取消令牌源，用於控制處理線程的生命週期
-        /// 當需要停止處理線程時，可以通過此令牌發出取消信號
+        /// 取消權杖來源，用於控制處理程序的生命週期
+        /// Cancellation token source for controlling the processor lifecycle
         /// </summary>
         private static readonly CancellationTokenSource _cancellationTokenSource = new CancellationTokenSource();
 
@@ -40,7 +48,8 @@ internal static class AsyncLogHandler
         private static bool _isInitialized;
 
         /// <summary>
-        /// 用於初始化同步的鎖對象
+        /// 用於初始化同步的鎖定物件
+        /// Lock object for initialization synchronization
         /// </summary>
         private static readonly object _lockObj = new object();
 
@@ -51,7 +60,8 @@ private static LogConfiguration.IAsyncLogOptions CurrentAsyncOptions
             => LogConfiguration.Current.AsyncOptions;
 
         /// <summary>
-        /// 上次寫入的時間
+        /// 最後一次寫入的時間戳記
+        /// Last write timestamp
         /// </summary>
         private static DateTime _lastFlushTime = DateTime.Now;
 

ozakboy.NLOG/ozakboy.NLOG/Core/ExceptionHandler.cs

@@ -5,22 +5,26 @@
 namespace ozakboy.NLOG.Core
 {
     /// <summary>
-    /// 異常處理器，負責異常資訊的收集和序列化
+    /// 異常處理器 - 負責收集和序列化異常資訊
+    /// Exception Handler - Responsible for collecting and serializing exception information
     /// </summary>
     internal static class ExceptionHandler
     {
         /// <summary>
-        /// 用於序列化的異常資訊類別，提供異常資訊的結構化存儲
+        /// 用於序列化的異常資訊類別 - 提供異常資訊的結構化存儲
+        /// Serializable Exception Info Class - Provides structured storage for exception information
         /// </summary>
         public class SerializableExceptionInfo
         {
             /// <summary>
-            /// 異常類型的完整名稱
+            /// 異常類型的完整名稱 - 包含命名空間的類型名稱
+            /// Full Exception Type Name - Type name with namespace
             /// </summary>
             public string Type { get; set; }
 
             /// <summary>
-            /// 異常的錯誤訊息
+            /// 異常的錯誤訊息 - 描述錯誤的具體內容
+            /// Exception Message - Detailed description of the error
             /// </summary>
             public string Message { get; set; }
 

ozakboy.NLOG/ozakboy.NLOG/Core/LogFormatter.cs

@@ -5,13 +5,18 @@
 namespace ozakboy.NLOG.Core
 {
     /// <summary>
-    /// 日誌格式化處理器
+    /// 日誌格式化處理器 - 負責將日誌內容轉換為標準格式
+    /// Log Formatter - Responsible for converting log content into standardized format
     /// </summary>
     internal static class LogFormatter
     {
         /// <summary>
-        /// 格式化日誌訊息
+        /// 格式化日誌訊息 - 將原始訊息轉換為包含時間戳記和執行緒 ID 的格式化訊息
+        /// Format Log Message - Converts raw message into formatted message with timestamp and thread ID
         /// </summary>
+        /// <param name="message">要格式化的訊息 / Message to format</param>
+        /// <param name="args">格式化參數 / Formatting parameters</param>
+        /// <returns>格式化後的訊息 / Formatted message</returns>
         public static string FormatMessage(string message, string[] args)
         {
             var sb = new StringBuilder();
@@ -27,8 +32,11 @@ public static string FormatMessage(string message, string[] args)
         }
 
         /// <summary>
-        /// 處理訊息中的特殊字符
+        /// 處理訊息中的特殊字符 - 確保訊息中的格式化字符被正確處理
+        /// Handle Special Characters - Ensures format characters in messages are properly handled
         /// </summary>
+        /// <param name="message">原始訊息 / Original message</param>
+        /// <returns>處理後的訊息 / Processed message</returns>
         public static string EscapeMessage(string message)
         {
             if (string.IsNullOrEmpty(message)) return message;

ozakboy.NLOG/ozakboy.NLOG/Core/LogItem.cs

@@ -4,33 +4,40 @@
 
 namespace ozakboy.NLOG.Core
 {
+
     /// <summary>
-    /// 日誌項目類別，用於在不同組件間傳遞日誌資訊
+    /// 日誌項目類別 - 用於在不同組件間傳遞日誌資訊
+    /// Log Item Class - Used for transferring log information between different components
     /// </summary>
     internal class LogItem
     {
         /// <summary>
-        /// 日誌級別
+        /// 日誌級別 - 定義日誌的重要程度
+        /// Log Level - Defines the severity of the log entry
         /// </summary>
         public LogLevel Level { get; set; }
 
         /// <summary>
-        /// 日誌名稱
+        /// 日誌名稱 - 用於識別日誌來源或類型
+        /// Log Name - Used to identify the source or type of log
         /// </summary>
         public string Name { get; set; }
 
         /// <summary>
-        /// 日誌訊息
+        /// 日誌訊息 - 記錄的實際內容
+        /// Log Message - The actual content of the log entry
         /// </summary>
         public string Message { get; set; }
 
         /// <summary>
-        /// 日誌參數
+        /// 日誌參數 - 用於格式化日誌訊息的參數陣列
+        /// Log Parameters - Array of parameters used for formatting log messages
         /// </summary>
         public object[] Args { get; set; }
 
         /// <summary>
-        /// 是否需要立即寫入
+        /// 是否需要立即寫入 - 控制日誌的即時性
+        /// Immediate Flush Required - Controls whether the log needs immediate writing
         /// </summary>
         public bool RequireImmediateFlush { get; set; }
     }

ozakboy.NLOG/ozakboy.NLOG/Core/LogLevel.cs

@@ -6,35 +6,49 @@ namespace ozakboy.NLOG.Core
 {
     /// <summary>
     /// 日誌級別
+    /// Log Levels
     /// </summary>
     public enum LogLevel
     {
         /// <summary>
-        /// 追蹤記錄檔
+        /// 追蹤記錄檔 - 用於追蹤程式執行的詳細流程
+        /// Trace Log - Used for tracking detailed program execution flow
         /// </summary>
         Trace = 0,
+
         /// <summary>
-        /// 測試記錄檔
+        /// 除錯記錄檔 - 用於開發階段的除錯訊息
+        /// Debug Log - Used for debugging messages during development
         /// </summary>
         Debug = 1,
+
         /// <summary>
-        /// 訊息記錄檔
+        /// 資訊記錄檔 - 記錄一般性的系統運作資訊
+        /// Info Log - Records general system operational information
         /// </summary>
         Info = 2,
+
         /// <summary>
-        /// 警告記錄檔
+        /// 警告記錄檔 - 記錄可能影響系統運作但不致嚴重的問題
+        /// Warning Log - Records potential issues that might affect system operation but are not severe
         /// </summary>
         Warn = 3,
+
         /// <summary>
-        /// 錯誤記錄檔
+        /// 錯誤記錄檔 - 記錄系統運作中的錯誤狀況
+        /// Error Log - Records error conditions in system operation
         /// </summary>
         Error = 4,
+
         /// <summary>
-        /// 致命記錄檔
+        /// 致命錯誤記錄檔 - 記錄導致系統無法運作的嚴重錯誤
+        /// Fatal Log - Records severe errors that cause system failure
         /// </summary>
         Fatal = 5,
+
         /// <summary>
-        /// 自定義名稱Log記錄檔
+        /// 自定義記錄檔 - 用於特定需求的客製化日誌類型
+        /// Custom Log - Customized log type for specific requirements
         /// </summary>
         CostomName = 99
     }

ozakboy.NLOG/ozakboy.NLOG/Core/LogSerializer.cs

@@ -10,7 +10,15 @@ namespace ozakboy.NLOG.Core
     internal static class LogSerializer
     {
         // 使用傳統的初始化方式以確保跨版本兼容
+        /// <summary>
+        /// 預設的 JSON 序列化選項
+        /// Default JSON serialization options
+        /// </summary>
         private static readonly JsonSerializerOptions _defaultOptions;
+        /// <summary>
+        /// 異常序列化專用的 JSON 序列化選項
+        /// JSON serialization options specifically for exceptions
+        /// </summary>
         private static readonly JsonSerializerOptions _exceptionOptions;
 
         // 在靜態建構函數中初始化

ozakboy.NLOG/ozakboy.NLOG/Core/LogText.cs

@@ -12,6 +12,10 @@ namespace ozakboy.NLOG.Core
     /// </summary>
     static class LogText
     {
+        /// <summary>
+        /// 同步鎖定物件，用於確保日誌寫入的執行緒安全
+        /// Synchronization lock object to ensure thread-safe log writing
+        /// </summary>
         private static object lockMe = new object();
 
         /// <summary>
@@ -193,12 +197,25 @@ private static void Remove_TimeOutLogText()
         #region Class
 
         /// <summary>
-        /// 日誌檔案資訊類
+        /// 日誌檔案資訊類別 - 用於管理單個日誌檔案的相關資訊
+        /// Log File Information Class - Used to manage information related to a single log file
         /// </summary>
         private class LogFileInfo
         {
+            /// <summary>
+            /// 日誌檔案所在目錄的完整路徑
+            /// Full path of the directory containing the log file
+            /// </summary>
             public string DirectoryPath { get; set; }
+            /// <summary>
+            /// 日誌檔案的完整路徑
+            /// Full path of the log file
+            /// </summary>
             public string FilePath { get; set; }
+            /// <summary>
+            /// 標記是否需要建立新的日誌檔案
+            /// Flag indicating whether a new log file needs to be created
+            /// </summary>
             public bool RequiresNewFile { get; set; }
         }