exception - XML 注释 - 如何注释异常的多个原因？

Question

下面是一个例子:

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 Example显示 FormatException 的 2 个不同原因.那么，它是这样做的:

/// <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>

Answer 1

如果您认为文档的每一行都是一个 <exception cref=...> </exception> ，那么从逻辑上讲，正确的做法是使用您的第二种选择:

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

您可以使用“p”元素来表示线条。