补齐注释

Author: walterlv

src/DotNetCampus.Logger/CompositeLogger.cs

@@ -30,6 +30,7 @@ public LogLevel Level
     /// </summary>
     public required IReadOnlyList<ILogger> Writers { get; init; }
 
+    /// <inheritdoc />
     public bool IsEnabled(LogLevel logLevel)
     {
         if (logLevel < Level)
@@ -40,6 +41,7 @@ public bool IsEnabled(LogLevel logLevel)
         return true;
     }
 
+    /// <inheritdoc />
     public void Log<TState>(LogLevel logLevel, EventId eventId, TState state, Exception? exception, Func<TState, Exception?, string> formatter)
     {
         if (logLevel < Level)

src/DotNetCampus.Logger/DotNetCampus.Logger.csproj

@@ -26,8 +26,6 @@
   <PropertyGroup>
     <!-- 仅在 net8.0 下才启用警告，其他框架全部关闭警告 -->
     <WarningLevel Condition="$(TargetFramework)!='net8.0'">0</WarningLevel>
-    <!-- Debug 下暂时忽略注释，否则注释警告会淹没正常警告。 -->
-    <NoWarn Condition="'$(Configuration)'=='debug'">CS1591</NoWarn>
   </PropertyGroup>
 
   <!-- 在 GitHub Action -->

src/DotNetCampus.Logger/LoggerBuilder.cs

@@ -29,31 +29,56 @@ public LoggerBuilder WithMemoryCache(MemoryCacheOptions? options = null)
         return this;
     }
 
+    /// <summary>
+    /// 指定日志记录器的日志级别。
+    /// </summary>
+    /// <param name="level">日志级别。</param>
+    /// <returns>用于链式调用的构建器。</returns>
     public LoggerBuilder WithLevel(LogLevel level)
     {
         _options ??= new LogOptions();
         _options.LogLevel = level;
         return this;
     }
 
+    /// <summary>
+    /// 指定日志记录器的配置选项。
+    /// </summary>
+    /// <param name="options">日志配置选项。</param>
+    /// <returns>用于链式调用的构建器。</returns>
     public LoggerBuilder WithOptions(LogOptions options)
     {
         _options = options;
         return this;
     }
 
+    /// <summary>
+    /// 添加一个日志写入器。
+    /// </summary>
+    /// <param name="writer">要添加的日志写入器。</param>
+    /// <returns>用于链式调用的构建器。</returns>
     public LoggerBuilder AddWriter(ILogger writer)
     {
         _writers.Add(writer);
         return this;
     }
 
+    /// <summary>
+    /// 添加一个日志桥接器。<br/>
+    /// 可通过编写一个 internal partial class LoggerBridgeLinker 并为其标记 [ImportLoggerBridge] 特性来实现自动生成桥接代码。
+    /// </summary>
+    /// <param name="linker">要添加的日志桥接器。</param>
+    /// <returns>用于链式调用的构建器。</returns>
     public LoggerBuilder AddBridge(ILoggerBridgeLinker linker)
     {
         _linkers.Add(linker);
         return this;
     }
 
+    /// <summary>
+    /// 创建复合日志记录器。
+    /// </summary>
+    /// <returns>复合日志记录器的构建器。</returns>
     public virtual LoggerBuilder<CompositeLogger> Build()
     {
         var logger = new CompositeLogger(_options ?? new LogOptions())

src/DotNetCampus.Logger/Writers/ConsoleLogger.cs

@@ -71,6 +71,7 @@ public ConsoleLogger(LogWritingThreadMode threadMode = LogWritingThreadMode.NotT
     /// </summary>
     private TagFilterManager? TagManager { get; }
 
+    /// <inheritdoc />
     public bool IsEnabled(LogLevel logLevel)
     {
         if (logLevel < Level)

src/DotNetCampus.Logger/Writers/ConsoleLoggerBuilder.cs

@@ -26,6 +26,11 @@ public ConsoleLoggerBuilder WithLevel(LogLevel level)
         return this;
     }
 
+    /// <summary>
+    /// 指定控制台日志的输出位置。
+    /// </summary>
+    /// <param name="outputTo">输出位置。</param>
+    /// <returns>用于链式调用的构建器。</returns>
     public ConsoleLoggerBuilder WithOutput(LoggerConsoleOutputTo outputTo)
     {
         _outputTo = outputTo;
@@ -36,7 +41,7 @@ public ConsoleLoggerBuilder WithOutput(LoggerConsoleOutputTo outputTo)
     /// 指定控制台日志的线程安全模式。
     /// </summary>
     /// <param name="threadMode">线程安全模式。</param>
-    /// <returns>构造器模式。</returns>
+    /// <returns>用于链式调用的构建器。</returns>
     /// <exception cref="ArgumentOutOfRangeException">线程安全模式不支持。</exception>
     public ConsoleLoggerBuilder WithThreadSafe(LogWritingThreadMode threadMode)
     {
@@ -48,7 +53,7 @@ public ConsoleLoggerBuilder WithThreadSafe(LogWritingThreadMode threadMode)
     /// 从命令行参数中提取过滤标签，使得控制台日志支持过滤标签行为。
     /// </summary>
     /// <param name="args">命令行参数。</param>
-    /// <returns>构造器模式。</returns>
+    /// <returns>用于链式调用的构建器。</returns>
     public ConsoleLoggerBuilder FilterConsoleTagsFromCommandLineArgs(IReadOnlyList<string> args)
     {
         _mainArgs = args;
@@ -76,7 +81,7 @@ public static class ConsoleLoggerBuilderExtensions
     /// </summary>
     /// <param name="builder">日志构建器。</param>
     /// <param name="configure">配置控制台日志记录器。</param>
-    /// <returns>日志构建器。</returns>
+    /// <returns>用于链式调用的构建器。</returns>
     public static LoggerBuilder AddConsoleLogger(this LoggerBuilder builder, Action<ConsoleLoggerBuilder> configure)
     {
         var consoleLoggerBuilder = new ConsoleLoggerBuilder();

src/DotNetCampus.Logger/Writers/DebugLogger.g.cs

@@ -9,6 +9,7 @@ namespace DotNetCampus.Logging.Writers;
 /// </summary>
 public class DebugLogger(ILogger realLogger) : ILogger
 {
+    /// <inheritdoc />
     public bool IsEnabled(LogLevel logLevel)
     {
         // 在 debug 模式下，所有日志都是可用的

src/DotNetCampus.Logger/Writers/TraceLogger.g.cs

@@ -9,6 +9,7 @@ namespace DotNetCampus.Logging.Writers;
 /// </summary>
 public class TraceLogger(ILogger realLogger) : ILogger
 {
+    /// <inheritdoc />
     public bool IsEnabled(LogLevel logLevel) => true;
 
     /// <inheritdoc />