Custom Klassenbibliothek, Funktionsbeschreibungen

  • VB.NET
  • .NET (FX) 4.0

Es gibt 5 Antworten in diesem Thema. Der letzte Beitrag () ist von Hinti.

    Custom Klassenbibliothek, Funktionsbeschreibungen

    Hallo Leute,

    Ich mache mir gerade eine Klassenbibliothek um nicht immer alles neu programmieren zu müssen.
    In der DLL sind dann meine eigenen Funktionen geshared. Klappt auch prima.

    Jedoch möchte ich zu meinen einzelnen Funktionen noch Beschreibungen anzeigen lassen, sowie man es von Standardfunktionen kennt. Siehe Bild. Da habe ich die Beschreibung mal eben rot eingekreist.

    So eine Beschreibung würde ich meinen eigenen Funktionen auch gerne verpassen. Geht das?, und wie?
    LG, Jürg
    Bilder
    • vb.net.funcdescr.png

      9,07 kB, 647×72, 202 mal angesehen
    Mach über der Funktion, Klasse, Property, Event , ... einfach 3 Hochkommas -> '''

    Dann wird der ein Rumpf erstellt wo du deine Beschreibung eintragen kannst:

    VB.NET-Quellcode

    1. ''' <summary>
    2. ''' Testklasse
    3. ''' </summary>
    4. ''' <remarks></remarks>
    5. Class Test
    6. ''' <summary>
    7. ''' Zahleneigenschaft
    8. ''' </summary>
    9. ''' <value></value>
    10. ''' <returns></returns>
    11. ''' <remarks></remarks>
    12. Public Property Zahl
    13. ''' <summary>
    14. ''' Eine Testmethode
    15. ''' </summary>
    16. ''' <param name="a">ein Text Parameter</param>
    17. ''' <param name="b">ein Zahlen Parameter</param>
    18. ''' <returns>Gibt einen Double retour</returns>
    19. ''' <remarks></remarks>
    20. Public Function TestFunc(ByVal a As String, b As Integer) As Double
    21. End Function
    22. End Class


    lg
    ScheduleLib 0.0.1.0
    Kleine Lib zum Anlaufen von Code zu bestimmten Zeiten
    wobei ich immer empfehle, auch diese Doku-Kommentare sparsam zu verwenden:
    • Keine Erklärungen, die sich eh aus dem MethodenNamen ergeben (zB das im Bildle rot umkringelte ist doch eiglich üflüssig)
    • keine leeren Doku-Comment-Tags
    Kommentare, auch Doku-Kommentare sind Code wie jeder annere auch, und müssen mitgepflegt werden, damit sie nicht "lügen".
    Und Kommentare, die kommentieren, was dem Code auch direkt abzulesen wäre, sind böse, denn sie lenken nur vom richtigen Code-Lesen ab.

    Ich persönlich dokumentiere übrigens - wenn nötig - möglichst alles (Rückgabewert, Exceptions) in den Summary-Tag, denn dieser ist der einzige, der im Code-Editor per Intellisense angezeigt wird.
    Hallo @fichz,
    Danke für den Hinweis. So einfach kann es oft sein :D.

    Jedoch frage ich dich jetzt noch etwas. Muss ich beim Compiler oder sonst wo in den Projekteigenschaften noch eine Option setzen, damit diese Beschreibungen entsprechend mit exportiert werden?

    Denn ich habe nun vor meiner Public Shared Funktion diese Summary Beschreibung gemacht, sehe in dem Projekt wo ich den Verweis (meine DLL) aufgenommen habe, jedoch nach wie vor nur die Funktionsbeschreibung... ohne meiner gewünschten und erstellten Beschreibung :(

    Hinti schrieb:

    in den Projekteigenschaften noch eine Option setze
    Ja.
    Projekt -> Eigenschaften -> XML-Dokumentationsdatei generieren.
    Diese Kommentare werden Dir angezeigt, wenn Du entsprechenden Code eingibst.
    Wenn Du eine DLL exportierst und die XML-Datei mitgibst, wird ihr Inhalt im ObjectBrowser angezeigt.
    Bilder
    • Doku.jpg

      10,46 kB, 377×140, 179 mal angesehen
    Falls Du diesen Code kopierst, achte auf die C&P-Bremse.
    Jede einzelne Zeile Deines Programms, die Du nicht explizit getestet hast, ist falsch :!:
    Ein guter .NET-Snippetkonverter (der ist verfügbar).
    Programmierfragen über PN / Konversation werden ignoriert!