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个不同原因.MSDNs 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>

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'元素来表示线条.