2009-08-14 37 views

cevap

24

kullanın sizin yöntemin belgelerine yorumlarda bir <exception/> tag:

: <exception/> etiketini kullanarak hakkında güzel şeyler

/// <summary>Does Foo</summary> 
/// <exception cref="System.ArgumentNullException"> 
/// Thrown when bar is null. 
/// </exception> 
public void Foo(Bar bar) 
{ 

} 

Bir Visual Studio böyle bir yöntem bilgileri araç ipucu bu bilgiye yer olmasıdır http://i32.tinypic.com/2e1gi6u.jpg

+1

+1 Belgelere, örneğe ve hatta ekran görüntüsüne bağlantı sağlamanın güzel cevabı. :) –

1

Tüm MSDN belgelerinde, her yöntem ne atabileceğini gösterir. Bu fikir gibi ve böylece benim yorumlarda ben böyle bir şey yapmak:

// atar: MyDangerousError, StupidProgrammerError

Eğer hangi durumlarda her hata açıklayabilir daha ayrıntılı gitmek istiyorum Hata adı kullanıcılara bir fikir vermek için yeterli olsa da, genellikle atılır.

+0

Lütfen bunu nasıl yapacağınızı öğrenmek için Andrew Hare'nin cevabını okuyun. Her yeni yöntem için kaynağınıza bakmak zorunda olmadıkça, kullanıcılar yorumlarınızı görmez! –

1

Ne yazık ki, netlik tek sorun değildir. Aksi takdirde, bu yapabilirdi:

public void Method_MayThrowException() { 
    .. 
} 

o başka nedenlerle istenmeyen bir yana, intellisense tarafından alınabilir bir açıklama iyi çalışacak muhtemeldir.

Ayrıca, eklentilere veya işlem değişikliklerine açık iseniz, SpeC# hakkında okuyabilirsiniz. Ya da FxCop kurallarını uygulayabilirsiniz.

İlgili konular