docs: Improve the comment of the code.

改进代码的注释。
This commit is contained in:
real-zony
2021-05-07 10:57:08 +08:00
parent 8e1e61764c
commit 6ec03d0ec3
12 changed files with 57 additions and 12 deletions

View File

@@ -4,7 +4,7 @@ using System.Text.RegularExpressions;
namespace ZonyLrcTools.Cli.Infrastructure.Lyric
{
/// <summary>
/// 每一行歌词的对象。
/// 歌词的对象,是 <see cref="LyricItemCollection"/> 的最小单位。
/// </summary>
public class LyricItem : IComparable<LyricItem>
{
@@ -121,6 +121,9 @@ namespace ZonyLrcTools.Cli.Infrastructure.Lyric
return HashCode.Combine(LyricText, Minute, Second);
}
/// <summary>
/// 获得歌词行的标准文本。
/// </summary>
public override string ToString() => $"[{Minute:00}:{Second:00.00}]{LyricText}";
}
}

View File

@@ -7,7 +7,7 @@ using ZonyLrcTools.Cli.Infrastructure.Extensions;
namespace ZonyLrcTools.Cli.Infrastructure.Lyric
{
/// <summary>
/// 歌词数据,包含多条歌词对象(<see cref="LyricItem"/>)。
/// 歌词数据,包含多条歌词对象(<see cref="LyricItem"/>)。
/// </summary>
public class LyricItemCollection : List<LyricItem>
{

View File

@@ -5,6 +5,9 @@ using ZonyLrcTools.Cli.Infrastructure.DependencyInject;
namespace ZonyLrcTools.Cli.Infrastructure.Lyric
{
/// <summary>
/// <see cref="ILyricItemCollectionFactory"/> 的默认实现。
/// </summary>
public class LyricItemCollectionFactory : ILyricItemCollectionFactory, ITransientDependency
{
private readonly ToolOptions _options;