VB 2010 - Wie kann ich z.B einer Klasse eine Beschreibung zuordnen ?

Question

Ich erstelle z.B eine Klasse in der eine Funktion "Plus" das Ergebnis von x+y zurück gibt.

Nun möchte ich irgendwo diese Funktion nutzen.

Bei den " mitgelieferten " Klassen etc. bekomme ich immer eine Erläuterung was die Klasse, Funktion etc. für eine Aufgabe hat.

Z.B. ich gebe ein "DIM" daraufhin bekomme ich die Info "Dim-Anweisung_deklariert eine oder..."

Kann ich auch selber so etwas realisieren, und wenn ja - wie ?

 

Answer 1

Hallo,

ich nehme mal an, das du die XML-Dokumentation meinst. Gehe einfach in die Zeile vor der zu beschreibenden Deklaration und setze dreimal das "Kommentareinleitungszeichen", den rest ergänzt dir VS:

'''<summer>
'''Beschreibung der Klasse
'''</summery>
Class Test

Das zeigt dir VS dann entsprechend als kurzbeschreibung beim auswählen des Typs/... an. Hier noch eine Seite mit den ganzen Formatierungs-Tags usw:
http://msdn.microsoft.com/de-de/library/5ast78ax.aspx
(Ist zwar C#, aber in VB.NET gehts genauso, einfach immer ''' anstelle von ///)

---

<Code:13/> - Koopakiller [kuːpakɪllɐ]
Webseite | Code Beispiele | Facebook | Snippets
Wenn die Frage beantwortet ist, dann markiert die hilfreichsten Beiträge als Antwort und bewertet die Beiträge. Danke.
Einen Konverter zwischen C# und VB.NET Code gibt es hier.

Answer 2

Perfekt - genau das war es :-) .... wie einfach es doch sein kann.

Vielen Dank

Für alle Anderen... ( nachdem ichs ausprobiert habe - mal ein praktisches Beispiel ( die Funktion ist allerdings " sinnfrei" )

 ''' <summary>
    ''' This is the function TOC :-)
    ''' </summary>
    ''' <param name="b">have to be a byte value Feld.</param>
    ''' <param name="s">have to be a string value Feld.</param>
    '''
    '''

    Function TestOfComments(b As Byte, s As String) As String ' only for demonstration maybe if b = 7 and s = "cool" you get "cool7"
        TestOfComments = s & Trim(Str(b))
    End Function