Wenn ich in C # entwickle, nutze ich GhostDoc sehr, um den Vorgang der Kommentierung meines Codes zu beschleunigen. Ich arbeite gerade an einem C ++ Projekt und habe kein gleichwertiges Tool gefunden. Ich weiß von Doxygen, aber von dem, was ich weiß, wird es verwendet, um Dokumentation außerhalb des Codes zu erstellen, nicht Kommentare im Code. Gibt es irgendwelche gleichwertigen Werkzeuge? Ich würde eine solche bevorzugen, die in VS läuft, aber ich könnte eine behandeln, die in jeder IDE funktioniert.
(Bevor jemand darauf hinweist, verlasse ich mich nicht nur auf GhostDoc, um Kommentare zu erstellen. Ich benutze es einfach, um den Ausgangspunkt für meine Kommentare zu erstellen.)
Visual Assist unterstützt Sie bei der Bereitstellung benutzerdefinierter Skripts, die während der Eingabe (oder auf anderem) ausgeführt werden.
Zum Beispiel können Sie ein Skript für Kommentare wie folgt haben:
%Vor%Das wäre zu empfehlen (über eine Combo-Box genau wie intellisense), wenn Sie beispielsweise mit "/ **" beginnen. Wenn Sie diesen Vorschlag auswählen (über Enter / Space / Click - anpassbar), wird das Skript an der Stelle eingefügt, an der sich der Cursor befindet, und nur die Zeichen zwischen $ Zeichen durch spezielle Werte ersetzt (wie zum Beispiel der aktuelle Dateiname). Hier setzt der $ end $ -Marker den Cursor an diese Position, wenn das Skript ausgeführt wird. Auf diese Weise schreiben Sie weiter reibungslos. Zum Beispiel mit dem vorherigen Skript-Set, genau zu tippen:
%Vor%wird einfach geben:
%Vor%Es ist sehr einfach anzupassen und das Verhalten des Vorschlags (lesen: intellisense ++) System ist anpassbar.
Ich habe ein Add-In geschrieben, Atomineer Pro-Dokumentation , das GhostDoc sehr ähnlich ist (es erzeugt / aktualisiert Dokumentationskommentare um viel Zeit und Aufwand beim Dokumentieren zu sparen), aber es analysiert den Code direkt für sich selbst und ist somit in der Lage C, C ++, C ++ / CLI, C #, Java und Visual Basic Code zu verarbeiten Der Umgebungscode muss nicht in einem kompilierenden Zustand sein, bevor er funktioniert. Es wird auch die Dokumentation für schwierigere Dinge wie Ausnahmen, die im Hauptteil einer Methode geworfen werden, automatisch hinzufügen / aktualisieren.
Es läuft unter Visual Studio 11, 2010, 2008 und 2005 und unterstützt die Kommentarfelder Documentation-Xml, Doxygen, JavaDoc und Qt sowie das Format / Stil von Kommentarblöcken und die verwendeten Auto-Doc-Regeln sind in hohem Maße konfigurierbar . Es verfügt über eine Reihe weiterer nützlicher Funktionen wie die Unterstützung von Konvertierungen von älteren Dokumentenkommentaren in die oben genannten Formate und das Umbrechen von Wörtern in Dok-Kommentaren und normalen Blockkommentaren.
Das obige ist nur eine Zusammenfassung einiger Schlüsselfunktionen - Dieser Vergleich von Funktionen mit anderen Produkten dient als vollständiger Liste der vielen anderen verfügbaren Funktionen.
Visual Assist könnte den Job machen, obwohl ich mir nicht ganz sicher bin.