Jak uzyskać intellisense dla niestandardowych klas stworzonych?

Question

Po wpisaniu "to". , zwykle dostajesz wszystkie procedury, zdarzenia i wiele więcej ... z aktualnej klasy, w której się znajdujesz. A kiedy po prostu przejdziesz do jednej z procedur na długiej liście bez wybierania jednej, zwykle otrzymasz opis obok niej.

Jak mogę to zrobić? Załóżmy, że mam klasę o nazwie CAR z dwiema procedurami: speed_up() i brake(). Jak mogę dokonać osoby korzystającej moją klasę, aby zobaczyć opis dwóch funkcji, gdy on typy:

CAR mycar = new CAR(); 
mycar. 

Answer 1

Przede klasy lub metody, raczej niż "//" komentarzu. jeśli wykonasz potrójny slash "///" (zwany również komentarzem XML), wykona on skrót, aby umożliwić wypełnienie informacji o klasie lub metodzie, którą komentujesz.

To wtedy pojawia się w kodzie jako taki

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

Gdy następnie dostęp do klasy lub metody poprzez ów INTELLISENSE kiedy pojawi się opis.

Answer 2

Daj klas i ich członków, XML comments, które pojawią się w intellisense. Najprostszym sposobem zrobienia tego w visual studio jest wpisanie /// powyżej tego, co chcesz dodać komentarze.

Na przykład

/// <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) 
    { 
    } 
} 

Powyższy stwierdzono here.

---

Zobacz także: How do you get XML comments to appear in a different project (dll)?

Answer 3

spróbuj dodać podsumowanie do swoich metod wpisując /// i wypełnić jak poniżej

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

można to zrobić dla każdej z metod i właściwości, tak aby sensownie wyświetla woli w IntelliSense.

Answer 4

Należy użyć formatu dokumentacji XML dostępne w Visual Studio dla każdego rodzaju konstrukcji (tj klasy, metody, właściwości ...)

do niego dostęp, typ /// na linii przed swoim oświadczeniu.

Na przykład:

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

dostaniesz coś takiego:

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

jeśli wpiszesz /// < można nawet uzyskać listę dostępnych elementów XML, jak uwagami lub reprezentują np Aby uzyskać więcej informacji, zobacz http://msdn.microsoft.com/en-us/magazine/cc302121.aspx

Answer 5

Komentarze można umieszczać w następujący sposób:

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

Answer 6

Musisz umieścić komentarz na nim tak:

/// <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; 
} 

można opisać korzystanie z funkcji <summary> i znaczenia paramaters <param name="">. Jeśli funkcja ma wartość zwracaną, możesz opisać ją znacznikiem <returns>. Istnieje kilka tagów mor, które będą wyświetlane przez studio graficzne, gdy napiszesz komentarz po trzech \.

Answer 7

Musisz dodać komentarze do dokumentu dla metod. możesz to zrobić ręcznie, wpisując "///" lub używając dodatku visual studio. Jeśli będziesz postępować zgodnie z zasadami nazewnictwa, to dodawanie pomoże ci w tym.