Fare ile şişirilen özet nasıl eklenir

Question

Bunun çok basit bir cevabı olacağından neredeyse eminim ama hiçbir yerde bulamıyorum. Hepimiz farenizi bir şey (örneğin bir dizge) üzerine getirdiğinizde, küçük bir özetin (eğer etkinse) açılacağını biliriz. Bir dize için, diyor ki:

sınıf System.string

Unicode karakter dizisi olarak metni temsil eder.

Ben benim sınıfların birinin üzerine fare, sadece dediğinde:

ben buldum iki bariz örnek denedim Namespace.Widget sınıfı:

/// <summary> 
/// This summary does not work, I know it's for html documenting tools but thought it was worth a shot. 
/// </summary> 

ve:

// Summary: 
//  This is what is in some of the base libraries, and does not work as well. 

Peki, nasıl açılır fareye bir özet eklerim?

Answer 1

Neden ilk denemenizin işe yaramayacağını anlamıyorum. Eğer, ücretsiz GhostDoc denemek senin yorumlama bazılarını otomatik hale yardımcı istiyorsanız bu

/// <summary> 
/// This text should automatically show up as the summary when hovering over 
/// an instance of this class in VS 
/// </summary> 
public class MyClass 
{ 
    public MyClass() {}  
} 

public class MyClass2 
{ 
    public MyClass() 
    { 
     //hovering over 'something' below in VS should provide the summary tooltip... 
     MyClass something = new MyClass(); 
    } 
} 

... bahsettiğin 'ipucunu' besler <summary> açıklama etiketiyle bu. En iyi ücretsiz VS eklentilerinden bir tanesi ..

Answer 2

Ayarlarınızı görsel stüdyosunda sıfırlayın, onlar berbat görünüyorlar. Ve ortaya çıkması için ilk örneği kullanmanız gerekecek.

Answer 3

Visual Studio'da IDE araç ipuçları oluşturmak için üç uçlu XML yorumları kullanılabilir. Özellikle, "özet" ve "istisna" çok iyi çalışıyor. ("Kod" gibi diğer şeyler, kullandığım Visual Studio sürümlerinde çalışmadı.)

Bu sizin için çalışmıyorsa, ayarlarınızda bir sorun olabilir.

Answer 4

İlk sözdizimini kullanmanız ve Visual Studio çözümünüzün dışında bir sınıf kullanıyorsanız, Proje Özellikleri'nde XML Belgesi Oluşturma dosyasını işaretlemeniz gerekir.