MRが楽しい

MRやVRについて学習したことを書き残す

HelpURL属性を設定して自作スクリプトのヘルプページのURLを指定する

本日はUnityの小ネタ枠です。
HelpURL属性を設定して自作スクリプトのヘルプページのURLを指定する方法です。

HelpURL属性

HelpURL属性はスクリプトに独自のドキュメントURLを指定します。
docs.unity3d.com

指定したURLはコンポーネント右上の[?]マークのアイコンから開くことができます。

サンプルスクリプト

HelpURL属性を指定した以下の自作スクリプトを作成しました。

using UnityEngine;

// ヘルプページのURLを指定
[HelpURL("https://bluebirdofoz.hatenablog.com/")]
public class PresetTest : MonoBehaviour
{
    [SerializeField]
    private int presetInt = 0;
    
    [SerializeField]
    private string presetString = "preset";
    
    [SerializeField]
    private bool presetBool = false;
}

任意のオブジェクトにコンポーネントを設定し、[?]マークのアイコンをクリックします。

ブラウザが立ち上がり、指定したURLが開きます。
自作スクリプトのヘルプページがある場合はURLを設定しておくと便利です。