<param>【メソッド パラメータ】
<typeparam>【ジェネリック型パラメータ】
<paramref>【パラメータ参照 (インライン)】
<typeparamref>【ジェネリック型パラメータ参照 (インライン)】
<returns>【戻り値】
<exception>【例外】
メモ
<param>【メソッド パラメータ】・<typeparam>【ジェネリック型パラメータ】
- メソッド パラメータ・ジェネリック型パラメータ
- 型情報は自動判定
- 構文チェック
- パラメータの過不足
<paramref>【パラメータ参照 (インライン)】・<typeparamref>【ジェネリック型パラメータ参照 (インライン)】
- インラインでパラメータ参照・ジェネリック型パラメータ参照
<returns>【戻り値】
- 戻り値の説明
- 改行:<para>【段落】で段落作成
- 構文チェック
- 存在チェック
<exception>【例外】
- 例外
- 構文チェック
- 存在チェック
構文
<param name="メソッド パラメータ名">パラメータの説明</param>
<paramref name="参照パラメータ名"/>
<typeparam name="型パラメータ名">型パラメータの説明</typeparam>
<typeparamref name="参照 型パラメータ名"/>
<returns>戻り値の説明</returns>
<exception cref="例外">例外の説明</exception>
外部リンク
- Microsoft Docs (英語)
- Sandcastle Help File Builder (英語)
例
/// <summary>
/// 除算 (<paramref name="p1"/> / <paramref name="p2"/>)
/// </summary>
/// <param name="p1">被除数</param>
/// <param name="p2">除数</param>
/// <returns>商</returns>
/// <exception cref="DivideByZeroException">0 で除算</exception>
public int Div(int p1, int p2)
{
return (int)(p1 / p2);
}
/// <summary>
/// 変数値交換 (<typeparamref name="T"/> ジェネリック型の変数値)
/// </summary>
/// <typeparam name="T">ジェネリック型パラメータの説明</typeparam>
/// <param name="p1">変数1の説明</param>
/// <param name="p2">変数2の説明</param>
public void Swap<T>(ref T p1, ref T p2)
{
T temp = p1;
p1 = p2;
p2 = p1;
}