<returns> (C# プログラミング ガイド)

<returns>description</returns>

パラメータ

• description
  戻り値の説明。

解説

<returns> タグは、メソッド宣言のコメント内で使用して、戻り値を説明します。

コンパイル時に /doc を指定してドキュメント コメントをファイルに出力します。

使用例

// compile with: /doc:DocFileName.xml 

/// text for class TestClass
public class TestClass
{
    /// <returns>Returns zero.</returns>
    public static int GetZero()
    {
        return 0;
    }

    /// text for Main
    static void Main()
    {
    }
}

参照

関連項目

ドキュメント コメント用の推奨タグ (C# プログラミング ガイド)

概念

C# プログラミング ガイド