Комментарии XML - Как прокомментировать несколько причин для исключения?

Question

Вот пример:

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

2 разных причины ArgumentNullException. 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>

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'для обозначения линий.