docs: Improved comments for the scanner.

This commit is contained in:
real-zony
2023-03-14 22:31:28 +08:00
parent b916323986
commit bc2b314d6a
2 changed files with 48 additions and 0 deletions

View File

@@ -2,8 +2,17 @@ using ZonyLrcTools.Common.Infrastructure.DependencyInject;
namespace ZonyLrcTools.Common.MusicScanner;
/// <summary>
/// 基于 CSV 文件的音乐信息扫描器。
/// </summary>
public class CsvFileMusicScanner : ITransientDependency
{
/// <summary>
/// 从 Csv 文件中获取需要下载的歌曲信息。
/// </summary>
/// <param name="csvFilePath">CSV 文件的路径。</param>
/// <param name="outputDirectory">歌词文件的输出目录。</param>
/// <param name="pattern">输出的歌词文件格式,默认是 "{Artist} - {Title}.lrc" 的形式。</param>
public async Task<List<MusicInfo>> GetMusicInfoFromCsvFileAsync(string csvFilePath, string outputDirectory, string pattern)
{
var csvFileContent = await File.ReadAllTextAsync(csvFilePath);