Architektur von Quellcodeverwaltungs-Plug-Ins
Sie können der integrierten Entwicklungsumgebung (IDE) von Visual Studio Unterstützung für die Quellcodeverwaltung hinzufügen, indem Sie ein Quellcodeverwaltung-Plugin implementieren und anhängen. Die IDE stellt eine Verbindung mit dem Quellcodeverwaltungs-Plug-In über die wohldefinierte Quellcodeverwaltungs-Plug-In-API bereit. Die IDE macht die Quellcodeverwaltungs-Features des Quellcodeverwaltungssystems verfügbar, indem eine Benutzeroberfläche bereitgestellt wird, die aus Symbolleisten und Menübefehlen besteht. Das Quellcodeverwaltungs-Plug-In implementiert die Quellcodeverwaltungs-Funktionalität.
Quellcodeverwaltungs-Plug-In-Ressourcen
Das Quellcodeverwaltungs-Plug-In stellt Ressourcen bereit, mit denen Sie Ihre Quellcodeverwaltungsanwendung mit der Visual Studio-IDE erstellen und verbinden können. Das Quellcodeverwaltungs-Plug-In enthält die API-Spezifikation, die von einem Quellcodeverwaltungs-Plug-In implementiert werden muss, damit es in die Visual Studio-IDE integriert werden kann. Es enthält auch ein Codebeispiel (geschrieben in C++), das ein Skelett-Quellcodeverwaltungs-Plug-In implementiert, das die Implementierung wesentlicher Funktionen veranschaulicht, die mit der Quellcodeverwaltungs-Plug-In-API kompatibel sind.
Mit der Spezifikation des Quellcodeverwaltungs-Plug-In-API können Sie ein beliebiges Quellcodeverwaltungssystem Ihrer Wahl nutzen, wenn Sie eine Quellcodeverwaltungs-DLL mit den erforderlichen Funktionen erstellen, die in Übereinstimmung mit der Quellcodeverwaltungs-Plug-In-API implementiert sind.
Komponenten
Das Quellcodeverwaltungs-Adapterpaket im Diagramm ist die Komponente der IDE, die die Anforderung des Benutzers für einen Quellcodeverwaltungsvorgang in einen Funktionsaufruf übersetzt, der vom Quellcodeverwaltungs-Plug-In unterstützt wird. Hierfür muss die IDE und das Quellcodeverwaltungs-Plug-In über ein effektives Dialogfeld verfügen, das Informationen zwischen der IDE und dem Plug-In zurückgibt. Damit dieser Dialog stattfinden kann, müssen beide die gleiche Sprache sprechen. Die in dieser Dokumentation beschriebene Quellcodeverwaltungs-Plug-In-API ist das allgemeine Vokabular für diesen Austausch.
Architekturdiagramm mit Interaktion zwischen VS- und Quellcodeverwaltungs-Plug-In
Wie im Architekturdiagramm dargestellt, hostet die Visual Studio-Shell, die als VS-Shell im Diagramm bezeichnet wird, die Arbeitsprojekte des Benutzers und zugehörige Komponenten, z. B. die Editoren und den Projektmappen-Explorer. Das Quellcodeverwaltungsadapterpaket behandelt die Interaktion zwischen der IDE und dem Quellcodeverwaltungs-Plug-In. Das Quellcodeverwaltungs-Adapterpaket stellt eine eigene Quellcodeverwaltungs-Benutzeroberfläche bereit. Es handelt sich um die Benutzeroberfläche der obersten Ebene, mit der der Benutzer interagiert, um den Umfang eines Quellcodeverwaltungsvorgangs zu initiieren und zu definieren.
Das Quellcodeverwaltungs-Plug-In kann über eine eigene Benutzeroberfläche verfügen, die aus zwei Teilen bestehen kann, wie in der Abbildung dargestellt. Das Feld mit der Bezeichnung „Anbieter-Benutzeroberfläche“ stellt benutzerdefinierte Benutzeroberflächen-Elemente dar, die Sie als Ersteller des Quellcodeverwaltungs-Plug-Ins bereitstellen. Diese werden direkt vom Quellcodeverwaltungs-Plug-In angezeigt, wenn der Benutzer einen erweiterten Quellcodeverwaltungsvorgang aufruft. Das Feld mit der Bezeichnung „Hilfsbenutzeroberfläche“ enthält eine Reihe von Plug-in-Funktionen für die Benutzeroberfläche der Quellcodeverwaltung, die indirekt über die IDE aufgerufen werden. Das Versionskontroll-Plugin übergibt Benutzeroberflächen-bezogene Nachrichten an die IDE über spezielle Rückruffunktionen, die von der IDE bereitgestellt werden. Die Hilfsbenutzeroberfläche erleichtert eine nahtlosere Integration in die IDE (häufig über die Verwendung einer Erweiterten Schaltfläche) und bietet somit eine einheitlichere Endbenutzerumgebung.
Ein Quellcodeverwaltungs-Plug-In kann keine Änderungen an der Visual Studio-Shell vornehmen und folglich entweder zum Quellcodeverwaltungs-Adapterpaket oder zur Quellcodeverwaltungs-Benutzeroberfläche, die von der IDE bereitgestellt wird. Sie muss die durch die Implementierung der verschiedenen Plug-In-API-Funktionen für die Quellcodeverwaltung gebotene Flexibilität maximal nutzen, die zu einer integrierten Benutzeroberfläche für den Endbenutzer beitragen. Der Referenzabschnitt der Dokumentation zur Quellcodeverwaltungs-Plug-In-API enthält Informationen zu einigen erweiterten Funktionen des Quellcodeverwaltungs-Plug-Ins. Um diese Features auszunutzen, muss das Quellcodeverwaltungs-Plug-In seine erweiterten Funktionen während der Initialisierung für die IDE deklarieren und für jede Funktion bestimmte erweiterte Funktionen implementieren.