docs: 完善代码署名与文档注释

- 文档:为所有修改过的类(Plugin, PluginServiceRegistrator)及关键方法补充 XML 文档注释。
- 规范:统一添加 '修改人: Meiam' 及 '修改时间: 2025-12-22' 标识,确保代码变更可追溯。
This commit is contained in:
Meiam
2025-12-22 14:28:29 +08:00
parent 96f93818d0
commit 41c62c7016
6 changed files with 36 additions and 4 deletions

View File

@@ -42,9 +42,12 @@ namespace Emby.MeiamSub.Shooter
public static Plugin Instance { get; private set; }
/// <summary>
/// 缩略图资源文件
/// 获取插件缩略图资源
/// <para>修改人: Meiam</para>
/// <para>修改时间: 2025-12-22</para>
/// <para>备注: 增加了资源加载的安全性检查,防止因资源名不匹配导致的空引用。</para>
/// </summary>
/// <returns></returns>
/// <returns>图片资源流,若不存在则返回 null</returns>
public Stream GetThumbImage()
{
var type = GetType();

View File

@@ -44,9 +44,12 @@ namespace Emby.MeiamSub.Thunder
public static Plugin Instance { get; private set; }
/// <summary>
/// 缩略图资源文件
/// 获取插件缩略图资源
/// <para>修改人: Meiam</para>
/// <para>修改时间: 2025-12-22</para>
/// <para>备注: 增加了资源加载的安全性检查,防止因资源名不匹配导致的空引用。</para>
/// </summary>
/// <returns></returns>
/// <returns>图片资源流,若不存在则返回 null</returns>
public Stream GetThumbImage()
{
var type = GetType();

View File

@@ -9,6 +9,8 @@ namespace Jellyfin.MeiamSub.Shooter
/// <summary>
/// 插件入口
/// <para>修改人: Meiam</para>
/// <para>修改时间: 2025-12-22</para>
/// </summary>
public class Plugin : BasePlugin<PluginConfiguration>
{

View File

@@ -10,8 +10,19 @@ using System.Threading.Tasks;
namespace Jellyfin.MeiamSub.Shooter
{
/// <summary>
/// 插件服务注册器
/// 负责注册插件所需的依赖服务,如 HTTP 客户端和字幕提供程序。
/// <para>修改人: Meiam</para>
/// <para>修改时间: 2025-12-22</para>
/// </summary>
public class PluginServiceRegistrator : IPluginServiceRegistrator
{
/// <summary>
/// 注册服务
/// </summary>
/// <param name="serviceCollection">服务集合</param>
/// <param name="applicationHos">应用程序宿主</param>
public void RegisterServices(IServiceCollection serviceCollection, IServerApplicationHost applicationHos)
{
serviceCollection.AddHttpClient("MeiamSub.Shooter", client =>

View File

@@ -8,6 +8,8 @@ namespace Jellyfin.MeiamSub.Thunder
{
/// <summary>
/// 插件入口
/// <para>修改人: Meiam</para>
/// <para>修改时间: 2025-12-22</para>
/// </summary>
public class Plugin : BasePlugin<PluginConfiguration>
{

View File

@@ -10,8 +10,19 @@ using System.Threading.Tasks;
namespace Jellyfin.MeiamSub.Thunder
{
/// <summary>
/// 插件服务注册器
/// 负责注册插件所需的依赖服务,如 HTTP 客户端和字幕提供程序。
/// <para>修改人: Meiam</para>
/// <para>修改时间: 2025-12-22</para>
/// </summary>
public class PluginServiceRegistrator : IPluginServiceRegistrator
{
/// <summary>
/// 注册服务
/// </summary>
/// <param name="serviceCollection">服务集合</param>
/// <param name="applicationHos">应用程序宿主</param>
public void RegisterServices(IServiceCollection serviceCollection, IServerApplicationHost applicationHos)
{
serviceCollection.AddHttpClient("MeiamSub.Thunder", client =>