【Unity】unityでXMLドキュメントコード（コメント）を使用する

はじめに

コメントを打ち込む際に
//
/* */
をよく用いると思います。

ただこれとは別に「///」を使うことで少し特殊なコメントを書くことができるみたいです。

今回はそれについて軽く触れていきたいと思います。

ドキュメントコメント

「///」を用いることでクラスやメソッドに軽い説明を付け加えることができるようになるようです。
簡単な例を紹介しましょう。

using UnityEngine;

public class SampleClass : MonoBehaviour {

    private void Start()
    {
        int a = 5;
        int b = 7;

        int c = Add(a, b);

        Debug.Log(c);
    }

    /// <summary>
    /// 二つの整数を足し算後に結果を返す
    /// </summary>
    /// <param name="a">足し算する数１</param>
    /// <param name="b">足し算する数２</param>
    /// <returns>演算結果</returns>
    private int Add(int a, int b)
    {
        return a + b;
    }
}