Übersicht über die Integration der Quellcodeverwaltung
In diesem Abschnitt werden die beiden Möglichkeiten zum Integrieren in die Visual Studio-Quellcodeverwaltung verglichen. ein Quellcodeverwaltungs-Plug-In und ein VSPackage, das eine Quellcodeverwaltungslösung bereitstellt, und hebt die neuen Quellcodeverwaltungsfeatures hervor. Visual Studio ermöglicht den manuellen Wechsel zwischen Quellcodeverwaltungs-VSPackages und Quellcodeverwaltungs-Plug-Ins sowie dem automatischen lösungsbasierten Wechsel.
Integration der Quellcodeverwaltung
Visual Studio unterstützt zwei Arten von Integrationsoptionen für die Quellcodeverwaltung. In allen Versionen von Visual Studio können Sie weiterhin ein Plug-In basierend auf der Quellcodeverwaltungs-Plug-In-API (zuvor auch als MSSCCI-API bezeichnet) integrieren, die grundlegende Quellcodeverwaltungsfunktionen bereitstellt, während Sie die Benutzeroberfläche der Visual Studio-Quellcodeverwaltung verwenden. Ein Quellcodeverwaltungs-VSPackage bietet dagegen einen neuen, deep-integration Visual Studio SDK-Pfad, der für die Integration der Quellcodeverwaltung geeignet ist, die ein hohes Maß an Raffinesse und Autonomie im Quellcodeverwaltungsmodell erfordert.
Quellcodeverwaltungs-Plug-In
Alle Versionen von Visual Studio unterstützen die Plug-In-API-Spezifikation der Quellcodeverwaltung, Version 1.2, als Integrationspfad. Ein Quellcodeverwaltungs-Plug-In-Implementierer schreibt eine DLL, die die Quellcodeverwaltungs-Plug-In-API-Funktionen für die Integration und Registrierung der Quellcodeverwaltung implementiert, wie im Erstellen eines Quellcodeverwaltungs-Plug-Ins beschrieben. Bei diesem Ansatz verwendet die IDE (Integrated Development Environment) die Visual Studio-Benutzeroberfläche für Dialogfelder, z. B. Einchecken, Auschecken, Tools/Optionen-Eigenschaftenseiten, Symbolleisten und Quellcodeverwaltungsglyphen. Die strikte Einhaltung der Quellcodeverwaltungs-Plug-In-API sichert eine einfache Integration in Visual Studio und eine problemlose Benutzererfahrung. Dies bedeutet, dass das Quellcodeverwaltungs-Plug-In die meisten Funktionen und Rückrufe implementieren muss, die in der API beschrieben sind.
Führen Sie die folgenden Schritte aus, um ein Quellcodeverwaltungs-Plug-In mithilfe der Quellcodeverwaltungs-Plug-In-API zu implementieren:
Erstellen Sie eine DLL, die die in Quellcodeverwaltungs-Plug-Ins angegebenen Funktionen implementiert.
Registrieren Sie die DLL, indem Sie die entsprechenden Registrierungseinträge erstellen (siehe Vorgehensweise: Installieren eines Quellcodeverwaltungs-Plug-Ins).
Erstellen Sie eine Hilfsbenutzeroberfläche, und zeigen Sie sie an, wenn Sie vom Quellcodeverwaltungsadapterpaket aufgefordert werden (die Visual Studio-Komponente, die Die Quellcodeverwaltungsfunktionen über Quellcodeverwaltungs-Plug-Ins behandelt)
Als Reaktion auf einen Quellcodeverwaltungsbefehl stellt die Visual Studio-IDE eine Standardbenutzeroberfläche für die grundlegenden Vorgänge dar und übergibt dann die Informationen über die in der Quellcodeverwaltungs-Plug-In-API definierten Funktionen an das Quellcodeverwaltungs-Plug-In. Für erweiterte Optionen kann das Quellcodeverwaltungs-Plug-In aufgerufen werden, um eine eigene Benutzeroberfläche darzustellen, z. B. beim Suchen nach einem quellcodegesteuerten Projekt. Dies bedeutet, dass dem Benutzer beim Umgang mit der Quellcodeverwaltung möglicherweise zwei verschiedene Ui-Stile angezeigt werden: die Benutzeroberfläche, die Visual Studio präsentiert, und die Benutzeroberfläche, die das Quellcodeverwaltungs-Plug-In darstellt. Dies ist am deutlichsten mit erweiterten Quellcodeverwaltungsvorgängen.
Nachteile bei der Implementierung eines Quellcodeverwaltungs-Plug-Ins
Bei erweiterten Features kann der Benutzer zwei verschiedene Schnittstellenarten sehen, was zu möglichen Verwirrungen führt.
Das Quellcodeverwaltungs-Plug-In ist auf das Quellcodeverwaltungsmodell beschränkt, das von der Quellcodeverwaltungs-Plug-In-API impliziert wird.
Die Quellcodeverwaltungs-Plug-In-API ist für einige Quellcodeverwaltungsszenarien möglicherweise zu restriktiv.
Vorteile der Implementierung eines Quellcodeverwaltungs-Plug-Ins
Visual Studio stellt alle Ui für alle grundlegenden Quellcodeverwaltungsvorgänge bereit, sodass das Quellcodeverwaltungs-Plug-In keine potenziell komplexe Benutzeroberfläche implementieren muss.
Aufgrund der strengen API kann das Quellcodeverwaltungs-Plug-In problemlos mit externen Quellcodeverwaltungsprogrammen interagieren, um umfangreichere Funktionen bereitzustellen. Visual Studio kümmert sich nicht um zu viel, wie die Quellcodeverwaltungsfunktion erreicht wird, nur, dass sie gemäß der Quellcodeverwaltungs-Plug-In-API erreicht wird.
Es ist einfacher, ein Quellcodeverwaltungs-Plug-In als ein Quellcodeverwaltungs-VSPackage zu implementieren.
Quellcodeverwaltung VSPackage
Das Visual Studio SDK ermöglicht eine umfassende Integration in Visual Studio mit vollständiger Kontrolle der Quellcodeverwaltungsfunktionen und vollständige Ersetzung der von Visual Studio bereitgestellten Benutzeroberfläche für die Quellcodeverwaltung. Ein Quellcodeverwaltungs-VSPackage wird in Visual Studio registriert und stellt Quellcodeverwaltungsfunktionen bereit. Obwohl mehrere Quellcodeverwaltungs-VSPackages in Visual Studio registriert werden können, kann jeweils nur eine von ihnen aktiv sein. Ein Quellcodeverwaltungs-VSPackage verfügt über die vollständige Kontrolle über die Funktionalität und Darstellung der Quellcodeverwaltung in Visual Studio, während sie aktiv ist. Alle anderen im System registrierten Quellcodeverwaltungs-VSPackages sind inaktiv und zeigen überhaupt keine Benutzeroberfläche an.
Für die Implementierung eines Quellcodeverwaltungs-VSPackage ist eine Strategie "alles oder nichts" erforderlich. Der Ersteller eines Quellcodeverwaltungs-VSPackage muss einen erheblichen Aufwand in die Implementierung einer Reihe von Quellcodeverwaltungsschnittstellen und neuen UI-Elementen (Dialogfelder, Menüs und Symbolleisten) investieren, um die gesamte Quellcodeverwaltungsfunktionalität abzudecken. Weitere Details finden Sie unter Erstellen eines VSPackage-Steuerelements .
Nachteile bei der Implementierung einer Quellcodeverwaltung VSPackage
VsPackage muss eine Reihe komplexer Schnittstellen implementieren, um erfolgreich in Visual Studio zu integrieren.
Das VSPackage muss alle ui bereitstellen, die für die Quellcodeverwaltung erforderlich sind. Visual Studio bietet in diesem Bereich keine Unterstützung.
Ein Quellcodeverwaltungs-VSPackage ist eng an Visual Studio gebunden und kann nicht mit eigenständigen Programmen verwendet werden. Daher kann die Funktionalität nicht so einfach mit einer externen Version des Quellcodeverwaltungsprogramms geteilt werden.
Vorteile beim Implementieren einer Quellcodeverwaltung VSPackage
Da das VSPackage die Vollständige Kontrolle über die Benutzeroberfläche und Funktionalität der Quellcodeverwaltung hat, wird dem Benutzer eine nahtlose Schnittstelle für die Quellcodeverwaltung angezeigt.
Das VSPackage ist nicht auf ein bestimmtes Quellcodeverwaltungsmodell beschränkt.