docs: 补全 C# XML 文档注释,覆盖所有公开与内部成员
为 14 个项目中缺少 XML 注释的类、接口、方法、属性、字段、record、 枚举等成员补全中文文档注释。接口方法在接口层定义完整注释,实现类 使用 <inheritdoc /> 引用。私有辅助方法结合业务语义编写注释。 扫描结果:missing-csharp-docs.txt 缺失项归零。 构建结果:0 警告,0 错误。 Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
This commit is contained in:
@@ -2,11 +2,21 @@ using FileShare_Services.Services.FileLibrary;
|
||||
|
||||
namespace FileShare_API.Services
|
||||
{
|
||||
/// <summary>
|
||||
/// 文件库定时扫描后台服务,每分钟执行一次扫描,检查是否有需要扫描的文件库目录。
|
||||
/// </summary>
|
||||
public sealed class FileLibraryScanHostedService(IServiceScopeFactory scopeFactory, ILogger<FileLibraryScanHostedService> logger)
|
||||
: BackgroundService
|
||||
{
|
||||
/// <summary>
|
||||
/// 扫描间隔,固定为 1 分钟。
|
||||
/// </summary>
|
||||
private static readonly TimeSpan Interval = TimeSpan.FromMinutes(1);
|
||||
|
||||
/// <summary>
|
||||
/// 启动扫描循环,首次立即执行,之后按 <see cref="Interval"/> 周期重复执行。
|
||||
/// </summary>
|
||||
/// <param name="stoppingToken">应用关闭时触发的取消令牌。</param>
|
||||
protected override async Task ExecuteAsync(CancellationToken stoppingToken)
|
||||
{
|
||||
await ScanAsync(stoppingToken);
|
||||
@@ -18,6 +28,10 @@ namespace FileShare_API.Services
|
||||
}
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// 创建临时作用域并调用 <see cref="IFileLibraryService.ScanDueRootsAsync"/> 执行一次到期扫描。
|
||||
/// </summary>
|
||||
/// <param name="cancellationToken">取消令牌。</param>
|
||||
private async Task ScanAsync(CancellationToken cancellationToken)
|
||||
{
|
||||
try
|
||||
|
||||
Reference in New Issue
Block a user