He aquí un ejemplo:XML Comments - ¿Cómo comentar múltiples razones para una excepción?
public void DoSomething(String param1, String param2)
{
if (param1 == null) throw new ArgumentNullException("param1");
if (param2 == null) throw new ArgumentNullException("param2");
}
2 razones diferentes para una ArgumentNullException. MSDNs String.Format Example muestra 2 motivos diferentes para el FormatException
. Entonces, ¿se hace de esta manera:
/// <exception cref="ArgumentNullException">
/// <paramref name="param1"/> is null.
/// </exception>
/// <exception cref="ArgumentNullException">
/// <paramref name="param2"/> is null.
/// </exception>
o de alguna otra manera?
/// <exception cref="ArgumentNullException">
/// Some other way to show the 2 reasons with an "-or-" between them.
/// </exception>
De hecho terminé usando eso, pero parecía ser que debería haber una mejor manera de hacerlo. Oh bien. Además, se debe utilizar en lugar de
. Son iguales, pero teniendo en cuenta que intellisense reconoceCreo que doblar el '', sería lo mismo que duplicar las filas de la tabla presentes en la documentación. Por supuesto, la etiqueta 'para' es mucho mejor. –