Unity エラーメッセージに注釈をつける

Question

Unityでの開発中にエラーが発生することがよくあり、
エラーメッセージ毎に解決法を表示したいと思います。

イメージとしては

####NullReferenceException: Object reference not set to an instance of an object
セットされていないオブジェクトがあります

エラーの種類を指定して注釈をつけるにはどうすればよろしいでしょうか？

Comments

[退会済みユーザー]

nullに割り込めれば出来るんじゃね？みたいな感じで安易に考えてみましたがそもそもnullって発生原因は山ほどあるので、それを特定して"セットされていないオブジェクトがあります"っていう部分を特定させる条件はかなり難しいんじゃないか？って思いました。

やっぱりnullはnullなんじゃないかと。

[LoiJack]

回答ありがとうございます。
説明が不足しており申し訳ありません。
エラーの発生原因は多くありますが、種類により代表的な原因や解決方法を
表示できればよいので原因の特定は出来なくてもよいと考えています。

Answer 1

リファレンスを検索してみたところ、ILogHandlerのページに独自のログハンドラーを作って特殊な動作をさせる例が載っていました。
これを利用して追加メッセージを出せないかと思い、例をまねて下記のようなスクリプトを作ってプロジェクト内の適当な場所に入れておき...

using System;
using System.Collections.Generic;
using UnityEngine;
using Object = UnityEngine.Object;

public class CustomLogHandler : ILogHandler
{
    // ここに捕捉したい例外と表示したい文章を登録しておく
    private static readonly Dictionary<Type, string> Remarks = new Dictionary<Type, string>
    {
        {typeof(NullReferenceException), "セットされていないオブジェクトがあります"},
        {typeof(IndexOutOfRangeException), "インデックスが配列の境界外です"}
    };

    // デフォルトのログハンドラーをとっておく
    private readonly ILogHandler defaultLogHandler = Debug.unityLogger.logHandler;
    
    // ゲームのロード時にログハンドラーをこのカスタムログハンドラーに差し替える
    [RuntimeInitializeOnLoadMethod]
    private static void OnLoad()
    {
        Debug.unityLogger.logHandler = new CustomLogHandler();
    }
    
    // LogFormatはデフォルトのログハンドラーでそのまま出力する
    public void LogFormat(LogType logType, Object context, string format, params object[] args)
    {
        this.defaultLogHandler.LogFormat(logType, context, format, args);
    }
    
    // LogExceptionはデフォルトのログハンドラーでそのまま出力したあと、
    // もし例外に対応する文章があればLogFormatでそれを出力する
    public void LogException(Exception exception, Object context)
    {
        this.defaultLogHandler.LogException(exception, context);
        if (Remarks.TryGetValue(exception.GetType(), out var remark))
        {
            this.defaultLogHandler.LogFormat(LogType.Exception, context, remark);
        }
    }
}

下記のようなスクリプトで例外を発生させたところ...

using UnityEngine;

public class DummyScript : MonoBehaviour
{
    private void Start()
    {
        ((Transform)null).position = Vector3.one;
    }
}

下図のように、例外メッセージに続いて追加のメッセージが出力されました。

Comments

[LoiJack]

すごいです！！！！
想像していた通りの出力です。
ソースのコメントも大変分かりやすいです。
ありがとうございます☺

Bongoさんは日曜プログラマとのことですが
リファレンスの見方や、問題の調査方法はどの様に学習したのでしょうか？

私はリファレンスを見ても理解できず、Qiitaなどの使用例を流用し動作確認して仕様を確認しています。

[Bongo]

他サイトで使用例を探してみるのは大いに結構なことかと思います。すぐにいい例がヒットしないようなら、英文あるいは英単語だけで検索してみるのもいいかもしれません。Stack Overflow（https://stackoverflow.com/ ）とか、本家運営のUnity Forum（https://forum.unity.com/ ）とかにはマイナーな機能についての話題も投稿されていることがあって、役に立つことが多く感じます。
今回のILogHandlerはリファレンスに使用例が載っていたものの、たしかにリファレンスだと簡潔な説明しかなく物足りないことも多いですね。リファレンスだけで機能の使い方を把握できなくてもお気になさる必要はないかと思います。他サイトで使用例を探して、それの裏取りみたいな感覚でリファレンスも見てみる...といった感じでいいんじゃないでしょうか。

[LoiJack]

ご教授ありがとうございます。
リファレンスについては見ても分からないからという理由で、敬遠していましたが
裏取りとして確認していきます。
参考サイトも確認させていただきます☺