Documentar una excepción en código C #

Me di cuenta en mscorlib.xml (el archivo XML que se genera a partir de los resúmenes) que contiene:

<member name="M:System.Console.ReadKey">
  <summary>Obtains the next character or function key pressed by the user. The pressed key is displayed in the console window.</summary>
  <returns>A <see cref="T:System.ConsoleKeyInfo" /> object that describes the <see cref="T:System.ConsoleKey" /> constant and Unicode character, if any, that correspond to the pressed console key. The <see cref="T:System.ConsoleKeyInfo" /> object also describes, in a bitwise combination of <see cref="T:System.ConsoleModifiers" /> values, whether one or more SHIFT, ALT, or CTRL modifier keys was pressed simultaneously with the console key.</returns>
  <exception cref="T:System.InvalidOperationException">The <see cref="P:System.Console.In" /> property is redirected from some stream other than the console.</exception>
  <filterpriority>1</filterpriority>
</member>

De ese ejemplo, estoy específicamente interesado en:

<exception cref="T:System.InvalidOperationException">The <see cref="P:System.Console.In" /> property is redirected from some stream other than the console.</exception>

¿Cómo se documentan las excepciones en el código para que terminen en XML?

preguntado el 28 de agosto de 11 a las 02:08

Pregunta extraña, ya que tú mismo ya das la respuesta :-) -

2 Respuestas

He aquí un ejemplo:

/// <exception cref="ArgumentException">
/// Thrown when the <typeparamref name="TConcrete"/> is a type
/// that can not be created by the container.
/// </exception>

En otras palabras, exactamente como el fragmento de código que ya mostró en su pregunta.

Respondido 28 ago 11, 07:08

Me acabo de dar cuenta de que: P. ¿Hay algún consejo para hacerlo más fácil? - Will

Bueno, supongo que al menos saber que no tengo que escribir el nombre completo lo hace un poco más fácil, así que gracias por eso. ¿Existe una lista de elementos y atributos que se pueden utilizar? - Will

Y no olvides las muy útiles <![CDATA[ (enlace). - Steven

Puede agregar la documentación de excepción con el <exception> etiqueta en los comentarios XML en su código fuente. Por ejemplo:

///<summary>Summary of method/property/etc</summary>
///<returns>Returns a value</returns>
///<exception>Throws an exception</exception>

Respondido 28 ago 11, 06:08

No es la respuesta que estás buscando? Examinar otras preguntas etiquetadas or haz tu propia pregunta.