はなちるのマイノート

Unityをメインとした技術ブログ。自分らしくまったりやっていきたいと思いますー!

【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">足し算する数1</param>
    /// <param name="b">足し算する数2</param>
    /// <returns>演算結果</returns>
    private int Add(int a, int b)
    {
        return a + b;
    }
}

このような書き方をした場合、VisualStudioでは以下の画像のような変化があります。

f:id:hanaaaaaachiru:20190120174429p:plain

f:id:hanaaaaaachiru:20190120174450p:plain

細かい説明

細かい説明は今回省かせていただきますが、こちらの記事を参照してみるといいと思います。

コメント - C#プチリファレンス

コメントを手っ取り早く書く - テラシュールブログ

【C#】XMLドキュメントコメントでparaタグを使用して改行する - コガネブログ

さいごに

ぜひとも分かりやすいコードを書きましょう!