Uno de los métodos que estoy creando arroja una excepción. ¿Cuál es la forma más clara de mostrar (ya sea en el código o en los comentarios) que mi método podría arrojar una excepción y, por lo tanto, se debe aplicar una prueba {} y atrapar {} a mi método.¿Cómo dejar en claro que un método puede arrojar una excepción?
Gracias!
Utilice un <exception/> tag en comentarios de la documentación de su método:
/// <summary>Does Foo</summary>
/// <exception cref="System.ArgumentNullException">
/// Thrown when bar is null.
/// </exception>
public void Foo(Bar bar)
{
}
Una de las cosas buenas sobre el uso de la etiqueta <exception/> es que Visual Studio incluirá esta información en la descripción de información método como este:
En toda la documentación de MSDN, cada método muestra lo que puede arrojar. Me gusta esta idea y por lo tanto en mis comentarios que hago algo así como:
// Lanza: MyDangerousError, StupidProgrammerError
Si quieres entrar en más detalles se puede explicar en qué situaciones cada error se arroja, a menudo, aunque el nombre del error es suficiente para darles a los usuarios una Idea.
Consulte la respuesta de Andrew Hare para aprender a hacerlo bien. Los usuarios no verán tus comentarios, a menos que quieras que tengan que mirar tu fuente para cada nuevo método. –
Lamentablemente, la claridad no es el único problema. De lo contrario, se podría hacer esto:
public void Method_MayThrowException() {
..
}
Dado que no es deseable por otras razones, un comentario que puede ser recogido por IntelliSense es probable que funcione mejor.
Además, si está abierto a complementos o modificaciones de proceso, puede leer sobre SpeC#. O podría implementar reglas de FxCop.
+1 Buena respuesta que proporciona un enlace a la documentación, ejemplo e incluso una captura de pantalla. :) –