Frage

Wenn ich in C # bin entwickeln, verwende ich stark GhostDoc den Prozess meinen Code zu kommentieren zu beschleunigen. Ich arbeite derzeit an einem C ++ Projekt und ich habe nicht ein gleichwertiges Werkzeug gefunden. Ich weiß, über Doxygen, aber von dem, was ich weiß, es Dokumentation außerhalb des Codes erstellen verwendet wird, nicht Kommentare im Code. Gibt es gute gleichwertige Werkzeuge? Ich würde vorziehen, die in VS läuft, aber ich konnte man behandeln, die in jedem IDE funktioniert.

(Bevor jemand es bringt, weiß ich nicht allein auf GhostDoc verlassen Kommentare zu erstellen. Ich kann es nur benutzen Sie den Ausgangspunkt für meine Kommentare zu erstellen.)

War es hilfreich?

Lösung

von Visual Assist hilft durch benutzerdefinierte Skripts Bereitstellung ausgeführt, während (oder auf andere) eingeben.

Zum Beispiel können Sie ein Skript für Kommentare wie diese:

/************************************************************************/
/* My comment : $end$                                                                     */
/************************************************************************/

Das würde (über eine Combo-Box genau wie IntelliSense) vorgeschlagen werden, wenn Sie die Eingabe von „/ **“ zum Beispiel beginnen. Wenn Sie diesen Vorschlag auswählen (via Enter / Space / Click - kundengerecht), wird es das Skript einfügen, wo Sie den Cursor und nur Marker ersetzen, die zwischen ‚$‘ Zeichen durch spezielle Werte (zum Beispiel wie die aktuelle Dateiname) sind. Hier ist das $ Ende $ Marker wird der Cursor an dieser Position sein, wenn das Skript ausgeführt wird. Auf diese Weise, Sie weiterhin die Eingabe reibungslos. Zum Beispiel mit dem vorherigen Skript Satz eingeben genau:

/** this is a test comment to show you one of the many features Visual Assit!

wird einfach geben:

/************************************************************************/
/* My comment : this is a test comment to show you one of the many features Visual Assit!                                                                     */
/************************************************************************/

Es ist wirklich einfach zu gestalten und das Verhalten des Vorschlags (sprich: intellisense ++). System anpassbar

Andere Tipps

Ich habe ein Add-In geschrieben, Atomineer Pro Dokumentation , das ist sehr ähnlich GhostDoc (es erzeugt / Updates Dokumentation Kommentare viel Zeit und Mühe zu sparen, wenn die Dokumentation), aber es analysiert den Code direkt für sich selbst und somit in der Lage zu handhaben C, C ++, C ++ / CLI, C #, Java und Visual Basic-Code, und nicht den umgebenden Code erfordert in einem Kompilierung Zustand zu sein, bevor es wird funktionieren. Es wird auch automatisch hinzufügen / Update-Dokumentation für weitere heikle Dinge wie Ausnahmen innerhalb des Körpers eines Verfahrens geworfen.

Es läuft unter Visual Studio 11, 2010, 2008 und 2005 und unterstützt die Dokumentation-Xml, Doxygen, JavaDoc und Qt Kommentierung Formate sowie das Format / Stil Kommentarblocks und die Auto-doc Regeln verwendet wird in hohem Maße konfigurierbar . Es hat eine Reihe weiterer nützlicher Funktionen wie Konvertierungen von Legacy-doc-Kommentare zu den obigen Formaten und Zeilenumbruch in doc-Kommentare und normalen Block Kommentare unterstützen.

Die oben ist nur eine Zusammenfassung einiger der wichtigsten Features - Diese Vergleich von Funktionen mit anderen Produkte dienen als eine vollständige Liste der vielen anderen Funktionen zur Verfügung.

von Visual Assist könnte die Arbeit tun, aber ich bin mir nicht ganz sicher.

Lizenziert unter: CC-BY-SA mit Zuschreibung
Nicht verbunden mit StackOverflow
scroll top