VS Code Dukumentation
-
Hallo Leute,
ich möchte mal bissel meine Code dokumentieren;) In Vs. gibt es ja die standard Dokumention Templates mit "///" und so...
Aber könnt ihr mir gute Doku-Addin für VS verraten? Mir wurde "GhostDoc" empfohlen, taugt das was, oder was würdet ihr vorschlagen?
Danke euch, und schönes WE;)
-
Hallo
Wenn du C# verwendest, kannst du den Sandcastle Help File Builder benutzen, gibt es auch als NuGet-Packet: https://www.nuget.org/packages/EWSoftware.SHFB/.
Wenn es aber nicht ausschließlich C# ist, dann würde ich dir zu doxygen raten. Hier hast du den Vorteil, dass du nicht an eine Entwicklungsumgebung oder Programmiersprache gebunden bist.
Zu GostDoc kann ich dir leider nichts sagen, da es bei meiner Auswahl wegen den Kosten nicht in die nähere Betrachtung gekommen ist. Ich verwende aktuell doxygen und bin sehr damit zu frieden. Das einzige was einem nicht gefallen könnte, ist die Darstellung, da diese sehr "Java-Doc" like ist, im Gegensatz zum Sandcaste Builder. Bei dem schaut die Ausgabe aus, als kommt sie von der MSDN.
Gruß Marco
-
hey Marco,
danke für dein Feedback, ich guck mir das mal an!
-
Das gratis GhostDoc ist lediglich ein Tool zum Erzeugen von "Undocumentation". Also zum automatisierten Erzeugen von "Beschreibungen" von Methoden, Parametern etc., nach dem Motto "GetBlub() - returns the Blub" -- woah, echt jetzt?
GhostDoc Pro würde dann CHM Files etc. erzeugen können, nur das geht auch mit SHFB. Ob bzw. wie viel besser GhostDoc Pro ist kann ich nicht sagen, aber SHFB funktioniert i.A. ganz gut. Bissi langsam, aber ich konnte bisher damit leben. Man muss ja nicht unbedingt 3x am Tag die Doku neu bauen lassen.
