8

次に例を示します。

public void DoSomething(String param1, String param2)
{
    if (param1 == null) throw new ArgumentNullException("param1");
    if (param2 == null) throw new ArgumentNullException("param2");
}

ArgumentNullExceptionの2つの異なる理由。MSDNのString.Formatの例は、の2つの異なる理由を示していFormatExceptionます。それで、それはこのように行われますか?

/// <exception cref="ArgumentNullException">
///     <paramref name="param1"/> is null.
/// </exception>
/// <exception cref="ArgumentNullException">
///     <paramref name="param2"/> is null.
/// </exception>

または他の方法?

/// <exception cref="ArgumentNullException">
///     Some other way to show the 2 reasons with an "-or-" between them.
/// </exception>
4

1 に答える 1

14

ドキュメントの各行が 1 であると考える場合<exception cref=...> </exception>、論理的に正しい方法は、2 番目の選択肢を使用することです。

/// <exception cref="ArgumentNullException">
///     <p><paramref name="param1"/> is null. </p>
///     <p>- or - </p>
///     <p><paramref name="param2"/> is null. </p>
/// </exception>

'p' 要素を使用して線を表すことができます。

于 2011-07-12T20:15:17.433 に答える