doc: 增加类注释

This commit is contained in:
Argo Zhang 2025-11-21 08:52:17 +08:00
parent 92cc3fd7cb
commit 75d944eaf7
2 changed files with 20 additions and 2 deletions

View File

@ -8,13 +8,31 @@ using System.Net;
namespace IP2Region.Net.Abstractions; namespace IP2Region.Net.Abstractions;
/// <summary>
/// IP 转化为地理位置搜索器接口
/// </summary>
public interface ISearcher public interface ISearcher
{ {
/// <summary>
/// 搜索方法
/// </summary>
/// <param name="ipStr">IP 地址字符串 如 192.168.0.1</param>
/// <returns></returns>
string? Search(string ipStr); string? Search(string ipStr);
/// <summary>
/// 搜索方法
/// </summary>
string? Search(IPAddress ipAddress); string? Search(IPAddress ipAddress);
/// <summary>
/// 搜索方法 仅限 IPv4 使用
/// </summary>
/// <param name="ipAddress">IPv4 地址字节数组小端读取 uint 数值</param>
string? Search(uint ipAddress); string? Search(uint ipAddress);
/// <summary>
/// 获得 内部 IO 访问次数
/// </summary>
int IoCount { get; } int IoCount { get; }
} }

View File

@ -73,4 +73,4 @@ public static class Util
return ret; return ret;
} }
} }