Exception XML注释-如何注释异常的多个原因?

Exception XML注释-如何注释异常的多个原因?,exception,xml-comments,Exception,Xml Comments,下面是一个例子: public void DoSomething(String param1, String param2) { if (param1 == null) throw new ArgumentNullException("param1"); if (param2 == null) throw new ArgumentNullException("param2"); } 2个不同的异常原因。MSDNs显示了格式异常的两种不同原因。那么,是这样做的: /// <

下面是一个例子:

public void DoSomething(String param1, String param2)
{
    if (param1 == null) throw new ArgumentNullException("param1");
    if (param2 == null) throw new ArgumentNullException("param2");
}
2个不同的异常原因。MSDNs显示了
格式异常的两种不同原因。那么,是这样做的:

/// <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>
//
///以其他方式显示这两个原因,并在它们之间加“-或“-”。
/// 

如果您认为文档的每一行都是一行,那么逻辑上正确的方法是使用第二种选择:

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

///-或-

///为空

///

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

我实际上最终使用了它,但似乎应该有更好的方法来实现这一点。哦,好吧。此外,应使用,而不是

。它们是相等的,但考虑到intellisense认可这一点,我认为这是首选。我认为将
加倍与将文档中的表行加倍相同。当然,
para
标签要好得多。