Özel oluşturulan sınıflar için intellisense nasıl edinilir?

Question

"Bu" yazdığınızda. , Genellikle tüm rutinleri, olayları almak ve içindedir. Ve eğer sadece birini seçerek olmadan uzun listedeki rutinleri biri üzerinde ayakta duruyorum, genellikle yanında bir tarifini geçerli sınıfın ... daha fazlası.

Bunu nasıl yapabilirim? İki rutine sahip CAR adında bir sınıfım olduğunu varsayalım: speed_up() ve brake().

CAR mycar = new CAR(); 
mycar. 

Answer 1

bir sınıf veya bir yöntem üzerinde, daha doğrusu bir "//" yorumun daha. Eğer (aksi bir XML yorum olarak da bilinir), bir "///" üçlü çizgi yaparsanız, bu size Yorumda sınıf veya yöntem hakkında bilgi doldurmak için izin vermek için bir kestirme gerçekleştirir. açıklama görünecektir zaman sonra intellisense thats aracılığıyla sınıf veya yöntemi erişirken

Bu da böyle

/// <summary> 
    /// 
    /// </summary> 
    /// <param name="sender"></param> 
    /// <param name="e"></param> 
    void Method(object sender, EventArgs e) 

olarak kodunuzda görünür. /// girdikten ve anlamlı IntelliSense içinde niyet görüntüler, böylece sen yöntemleri ve özellikleri her biri için bunu yapabilirsiniz

/// <summary> 
/// This is my speed up method 
/// </summary> 
public void speed_up(){ ...} 

altında gibi dolmaya ederek yöntemlere özetini ekleyerek

Answer 2

intellisense görünecektir sizin sınıfları ve üyelerini, XML comments, ver: nasıl o tipleri, iki fonksiyonları bir açıklama görmek için benim sınıf kullanarak kişiyi yapabilirsiniz. Görsel stüdyoda bunu yapmanın en kolay yolu, yorum eklemek istediğinizin üzerine /// yazarakdır. Örneğin

:

/// <summary> 
/// Class level summary documentation goes here.</summary> 
/// <remarks> 
/// Longer comments can be associated with a type or member through 
/// the remarks tag.</remarks> 
public class TestClass : TestInterface 
{ 
    /// <summary> 
    /// Store for the name property.</summary> 
    private string _name = null; 

    /// <summary> 
    /// The class constructor. </summary> 
    public TestClass() { } 

    /// <summary> 
    /// Description for SomeMethod.</summary> 
    /// <param name="s"> Parameter description for s goes here.</param> 
    /// <seealso cref="System.String"> 
    /// You can use the cref attribute on any tag to reference a type or member 
    /// and the compiler will check that the reference exists. </seealso> 
    public void SomeMethod(string s) 
    { 
    } 
} 

yukarıda here bulunmuştur.

---

Ayrıca bakınız: How do you get XML comments to appear in a different project (dll)?

Answer 3

deneyin.

Answer 4

Her tip yapılar için Görsel stüdyoda Kullanılabilir XML belgeleri biçimini kullanın (yani sınıf, yöntemleri, özellikleri ...)

erişmek için, bildiriminden önce on line tipi /// olmalıdır.

/// 
    public void Method(string p){... 

alırsınız gibi bir şey: Mesela

/// <summary> 
    /// 
    /// </summary> 
    /// <param name="p"></param> 
    public void Method(string p){... 

yazarsanız /// < hatta sözlerden veya exemple gibi mevcut XML öğelerinin listesini alacak Daha fazla bilgi için, bkz. http://msdn.microsoft.com/en-us/magazine/cc302121.aspx

Answer 5

Aşağıdaki gibi yorum ekleyebilirsiniz:

/// <summary> 
/// This sppeds up the car 
/// </summary> 
public void speed_up() 
{ } 

Answer 6

Böyle Üzerinde bir yorum koymak zorunda:

/// <summary> 
/// This is my function. 
/// </summary> 
/// <param name="myParameter">This parameter is very important.</param> 
/// <returns>It returns always 42.</returns> 
public int MyFunction(string myParameter) 
{ 
    return 42; 
} 

İşlevin <summary> kullanımını ve Paramaters <param name=""> anlamını tarif edebilir. Fonksiyonun bir dönüş değeri varsa, bunu <returns> etiketiyle tanımlayabilirsiniz. Desteklenen bazı mor etiketler vardır, üç \ sonra yorumunuzu yazdığınızda, görsel stüdyo tarafından listelenecektir.

Answer 7

Yöntemler için belge yorumları eklemeniz gerekir. bunu '///' yazarak veya görsel stüdyo eklentisini kullanarak el ile yapabilirsiniz. GhostDoc iyi adlandırma kurallarını izlerseniz, bu konuda size yardımcı olacaktır.