docs: 完善代码的 XML 注释。

This commit is contained in:
real-zony 2021-10-21 16:01:06 +08:00
parent bd09b8394d
commit 6e95946eca
3 changed files with 15 additions and 0 deletions

View File

@ -8,6 +8,7 @@ using ZonyLrcTools.Cli.Infrastructure.DependencyInject;
namespace ZonyLrcTools.Cli.Infrastructure.Tag
{
/// <inheritdoc cref="ZonyLrcTools.Cli.Infrastructure.Tag.IBlockWordDictionary" />
public class BlockWordDictionary : IBlockWordDictionary, ISingletonDependency
{
private readonly ToolOptions _options;

View File

@ -1,5 +1,8 @@
namespace ZonyLrcTools.Cli.Infrastructure.Tag
{
/// <summary>
/// 屏蔽词选项类。
/// </summary>
public class BlockWordOption
{
/// <summary>

View File

@ -1,7 +1,18 @@
namespace ZonyLrcTools.Cli.Infrastructure.Tag
{
/// <summary>
/// 屏蔽词字典。
/// </summary>
public interface IBlockWordDictionary
{
/// <summary>
/// 根据 <paramref name="key"/> 获得屏蔽词结果。
/// </summary>
/// <remarks>
/// 例: 原歌曲的 "fuckking" ,在网易云实际为 "***kking"。
/// </remarks>
/// <param name="key">原始单词。</param>
/// <returns>原始单词对应的屏蔽词。</returns>
string GetValue(string key);
}
}