[gelöst] Klassenbibliothek: Funktions- und Parameter-Beschreibungen pflegen

Hallo Leute,

Ich habe mir eine kleine dll erstellt, welche kleine aber oft gebrauchte Funktionen enthält, welche ich in verschiedenen Projekten nutze.

Meine Frage ist, ob ich eine Art Dokumentation dafür erstellen kann. Also Hilfe-Texte, welche bei der Verwendung der Klasse angezeigt werden?

Wenn ich z.b. aus dem IO-Namespace das File.Create anwende, öffnet sich ein Tooltip, welcher mir die Parameter anzeigt und eine Beschreibung, was diese Klasse/Funktion tut.

Dies wollte ich gerne auch für meine dll haben und frage mich, wie ich dies umsetzen kann. Es sollte auch Beschreibungen für die einzelnen Parameter geben können etc.

Sowas gibt es bestimmt, nur leider finde ich es mit meinen Suchbegriffen nicht.

Könnt Ihr mir sagen, womit ich dies umsetzen kann? 😃

Gruß
Gnozo

Hallo Gnozo

Nutze dafür die XML-Kommentare für Typen, Methoden, ...
Diese werden dann genutzt, um die Tooltips anzuzeigen.

Gruss Peter

Das sind die Summaries, die nachher Visual Studio zu einem <name der dll>.xml formt, wenn das in den Projekteinstellungen unter Build hinterlegt ist.
Diese muss dann immer zusammen mit der DLL mitgegeben werden.
Sieht am Ende dann so aus: XML Summaries QuickIO.NET

Ah sehr schön,

Vielen Danke an euch! 😃

Kannst dir dazu auch noch GhostDoc laden. Das ist ein Tool das dir zumindest grob behilflich dabei ist die Doc zu erstellen

... wobei die Qualität von GhostDoc eher schlecht als recht ist.
Einziger Vorteil ist, dass es im Gegensatz zu Visual Studio auch die Dokumentationselemente für Exceptions direkt erstellt (Plugin: Agent Johnson).

Ich benutze da lieber "Atomineer Pro".
Hat einige Möglichkeiten mehr.

Naja gut das hat dafür aber auch ne 30Day Trial

Und ein bisschen besser als die VS interne autodokumentation ist ghostdoc schon. Schon allein das dieser die Doku aus geerbten Interfaces übernimmt