Uno dei metodi che sto creando genera un'eccezione. Qual è il modo più chiaro di mostrare (nel codice o nei commenti) che il mio metodo potrebbe generare un'eccezione e quindi è necessario applicare un metodo try {} e catch {} al mio metodo.Come chiarire che un metodo può generare un'eccezione?
Grazie!
Utilizzare un <exception/> tag nei commenti documentazione del metodo:
/// <summary>Does Foo</summary>
/// <exception cref="System.ArgumentNullException">
/// Thrown when bar is null.
/// </exception>
public void Foo(Bar bar)
{
}
Una delle cose belle su come usare la tag <exception/> è che Visual Studio includerà questa informazione nella descrizione informazioni metodo come questo:
In tutta la documentazione MSDN, ogni metodo mostra ciò che può generare. Mi piace questa idea e quindi nei miei commenti che faccio qualcosa di simile:
// getta: MyDangerousError, StupidProgrammerError
Se si vuole andare più in dettaglio si può spiegare in quali situazioni ogni errore viene lanciato, spesso anche se il nome dell'errore è sufficiente per fornire agli utenti un'idea.
Si prega di vedere la risposta di Andrew Hare per imparare come farlo bene. Gli utenti non vedranno i tuoi commenti, a meno che tu non voglia che guardino la tua fonte per ogni nuovo metodo! –
Purtroppo la chiarezza non è l'unico problema. In caso contrario, si potrebbe fare questo:
public void Method_MayThrowException() {
..
}
Dal momento che è indesiderabile per altri motivi, un commento che può essere raccolto da IntelliSense è in grado di lavorare al meglio.
Inoltre, se si è aperti a componenti aggiuntivi o si elaborano modifiche, è possibile leggere su SpeC#. O potresti implementare le regole FxCop.
+1 Risposta piacevole che fornisce il collegamento a documentazione, esempio e persino uno screenshot. :) –