L'une des méthodes que je crée génère une exception. Quelle est la manière la plus claire d'afficher (dans le code ou dans les commentaires) que ma méthode pourrait déclencher une exception, et donc un try {} et un catch {} doivent être appliqués à ma méthode.Comment faire comprendre qu'une méthode peut déclencher une exception?
Merci!
Utilisez un <exception/> tag dans les observations de votre méthode de documentation:
/// <summary>Does Foo</summary>
/// <exception cref="System.ArgumentNullException">
/// Thrown when bar is null.
/// </exception>
public void Foo(Bar bar)
{
}
Une des belles choses sur l'utilisation de la balise <exception/> est que Visual Studio inclura ces informations dans l'info-bulle d'information méthode comme ceci:
Dans toute la documentation MSDN, chaque méthode montre ce qu'elle peut lancer. J'aime cette idée et donc dans mes commentaires que je fais quelque chose comme:
// jette: MyDangerousError, StupidProgrammerError
Si vous voulez aller plus en détail, vous pouvez expliquer dans quelles situations chaque erreur est lancé, souvent même si le nom de l'erreur est suffisant pour donner aux utilisateurs une idée.
S'il vous plaît voir la réponse d'Andrew Hare pour apprendre comment le faire correctement. Les utilisateurs ne verront pas vos commentaires, sauf si vous voulez qu'ils regardent votre source pour chaque nouvelle méthode! –
Malheureusement, la clarté n'est pas le seul problème. Sinon, vous pouvez le faire:
public void Method_MayThrowException() {
..
}
Puisque c'est indésirable pour d'autres raisons, un commentaire qui peut être capté par IntelliSense est susceptible de travailler le meilleur.
En outre, si vous êtes ouvert aux modules complémentaires ou aux modifications de processus, vous pouvez en savoir plus sur le numéro de spécification. Ou vous pouvez implémenter des règles FxCop.
+1 Belle réponse fournissant un lien vers la documentation, un exemple et même une capture d'écran. :) –