Jedna z metod, które tworzę, zgłasza wyjątek. Jaki jest najczystszy sposób wyświetlania (w kodzie lub komentarzach), że moja metoda może wyrzucić wyjątek, a zatem do mojej metody musi zostać zastosowana metoda try {} i catch {}.Jak wyjaśnić, że metoda może wyrzucić wyjątek?
Dzięki!
Użyć <exception/> tag w komentarzach dokumentacji metodę za:
/// <summary>Does Foo</summary>
/// <exception cref="System.ArgumentNullException">
/// Thrown when bar is null.
/// </exception>
public void Foo(Bar bar)
{
}
Jedną z miłych rzeczy o użyciu znacznika <exception/> jest, że Visual Studio będzie zawierać te informacje w dymku informacyjnym metoda takiego:
We wszystkich dokumentach MSDN każda metoda pokazuje, co może rzucić. Lubię ten pomysł, a więc w moich komentarzach zrobić coś takiego:
// rzuca: MyDangerousError, StupidProgrammerError
Jeśli chcesz, aby przejść do bardziej szczegółowo można wyjaśnić w jakich sytuacjach każdego błędu jest wyrzucany, często jednak nazwa błędu wystarcza, aby dać użytkownikom pomysł.
Proszę zobaczyć odpowiedź Andrew Hare, aby dowiedzieć się, jak to zrobić dobrze. Użytkownicy nie zobaczą twoich komentarzy, chyba że chcesz, żeby musieli patrzeć na twoje źródło dla każdej nowej metody! –
Niestety, jasność nie jest jedyną kwestią. W przeciwnym razie, można to zrobić:
public void Method_MayThrowException() {
..
}
Ponieważ jest niepożądane z innych powodów, komentarz, który może być odebrany przez intellisense prawdopodobnie działają najlepiej.
Ponadto, jeśli jesteś otwarty na dodatki lub modyfikacje procesów, możesz przeczytać o specyfikacji #. Lub możesz wdrożyć zasady FxCop.
+1 Dobra odpowiedź z linkiem do dokumentacji, przykładu, a nawet zrzutu ekranu. :) –