docs(codecs): セーブデータコーデック基盤へのXMLドキュメントコメント付与および実装スタイルの整理

This commit is contained in:
armonica committed 2026-10-14 17:01:02 +09:00
1 parent 922f669191
commit ee7b37323c
4 files changed
+175 -42

No files matched your search

+30 -8
View File
@@ -1,6 +1,6 @@
using System.Collections.Generic;
using GameLauncher.Models;
using System.Collections.Generic;
using GameLauncher.Engines.Unity;
using GameLauncher.Models;
namespace GameLauncher.Services.Codecs
{
@@ -9,22 +9,44 @@ namespace GameLauncher.Services.Codecs
/// </summary>
public interface ISaveDataCodec
{
/// <summary>コーデックの識別名称(例: "Easy Save 3 (ES3)", "YU-RIS セーブデータ")</summary>
/// <summary>
/// コーデックの識別名称(例: "Easy Save 3 (ES3)", "YU-RIS セーブデータ")を取得します。
/// </summary>
string CodecName { get; }
/// <summary>このコーデックで指定ファイルを処理可能か判定</summary>
/// <summary>
/// このコーデックで指定ファイルを処理可能か判定します。
/// </summary>
/// <param name="game">対象のUnityゲーム情報</param>
/// <param name="file">対象のセーブファイル情報</param>
/// <returns>処理可能な場合は true、それ以外は false</returns>
bool CanHandle(UnityGameItem game, SaveFileEntry file);
/// <summary>セーブファイルからGUI編集用プロパティ一覧をロード・解析</summary>
/// <summary>
/// セーブファイルからGUI編集用プロパティ一覧をロード・解析します。
/// </summary>
/// <param name="filePath">セーブファイルの絶対パス</param>
/// <param name="optionalPassword">任意の暗号化パスワード</param>
/// <returns>展開されたセーブデータプロパティのリスト</returns>
List<SaveDataPropertyEntry> LoadProperties(string filePath, string? optionalPassword = null);
/// <summary>GUI編集されたプロパティ一覧をファイルへ再エンコード・保存</summary>
/// <summary>
/// GUI編集されたプロパティ一覧をファイルへ再エンコード・保存します。
/// </summary>
/// <param name="filePath">保存先セーブファイルの絶対パス</param>
/// <param name="properties">編集されたプロパティ一覧</param>
/// <param name="optionalPassword">任意の暗号化パスワード</param>
/// <returns>保存に成功した場合は true、それ以外は false</returns>
bool SaveProperties(string filePath, List<SaveDataPropertyEntry> properties, string? optionalPassword = null);
/// <summary>復号にパスワードやキーが必要かどうか</summary>
/// <summary>
/// 復号にパスワードやキーが必要かどうかを取得します。
/// </summary>
bool RequiresPassword { get; }
/// <summary>パスワード入力時の案内メッセージ</summary>
/// <summary>
/// パスワード入力時の案内メッセージを取得します。
/// </summary>
string? PasswordPromptMessage { get; }
}
}