Prüfliste für bewährte Methoden zum Veröffentlichen einer Visual Studio-Erweiterung

Im Folgenden finden Sie eine Liste der Punkte, die Sie vor der Veröffentlichung der Visual Studio-Erweiterung beachten müssen.

Im folgenden Video werden bewährte Methoden vorgestellt, um sicherzustellen, dass Ihre Erweiterung am besten geeignet ist.

Beachten Sie die Threadingregeln

Fügen Sie das NuGet-Paket "Microsoft.VisualStudio.SDK.Analyzers NuGet" zu Ihrem VSIX-Projekt hinzu, das Ihnen hilft, häufige Verstöße gegen bewährte Methoden für Threading zu ermitteln und zu beheben.

Ein hochwertiges Icon hinzufügen

Allen Erweiterungen sollte ein Symbol zugeordnet sein. Stellen Sie sicher, dass das Symbol eine qualitativ hochwertige .png Datei mit der Größe 90 x 90 Pixel in 96 DPI oder mehr ist. Nachdem Sie das Symbol zu Ihrem VSIX-Projekt hinzugefügt haben, registrieren Sie es in der VSixmanifest-Datei sowohl als Symbol als auch als Vorschaubild.

Name und Beschreibung

Studien zeigen, dass Erweiterungen mit einem kurzen und beschreibenden Namen und einer genauen Beschreibung wahrscheinlicher von Benutzern installiert werden. Stellen Sie sicher, dass der Name das Wesen der Erweiterung widerspiegelt. Die kurze Beschreibung in der VSIXMANIFEST-Datei sollte Erwartungen hinsichtlich der Funktionsweise der Erweiterung festlegen. Eine kurze Erwähnung der Probleme, die es löst, und welche Hauptfunktionen es hat, sind der Schlüssel.

Gute Marketplace-Beschreibung schreiben

Dies ist eine der wichtigsten Dinge, die Sie tun sollten, um Ihre Erweiterung erfolgreich zu machen. Eine gute Beschreibung besteht aus:

• Screenshots/animierte GIFs der Benutzeroberfläche, die von der Erweiterung hinzugefügt wurden.
• Detaillierte Beschreibung der einzelnen Features.
• Links zu weiteren Details, falls zutreffend.

Lizenz hinzufügen

Diese Lizenz wird auf dem Marketplace, im VSIX-Installationsprogramm und im Dialogfeld Erweiterungen und Updates... angezeigt. Eine Lizenz sollte immer angegeben werden, um die Erwartungen für die Benutzer festzulegen. Verwenden Sie choosealicense.com , um die richtige Lizenz für Sie zu finden. Eine Lizenz ist wichtig, um Fragen und Mehrdeutigkeiten zu entfernen, was für viele Visual Studio-Benutzer wichtig ist.

Datenschutzhinweis hinzufügen

Wenn die Erweiterung Daten wie Telemetrie sammelt oder auf andere Weise mit einem Remoteendpunkt kommuniziert, fügen Sie in der Beschreibung eine Notiz dazu hinzu.

Verwenden von KnownMonikers nach Möglichkeit

Visual Studio enthält Tausende von Symbolen, die in der KnownMonikers-Auflistung verfügbar sind. Wenn Sie Symbole zu Befehlsschaltflächen hinzufügen, überprüfen Sie, ob Sie die vorhandenen KnownMonikers-Symbole verwenden können, da sie Teil einer Entwurfssprache sind, die den Visual Studio-Benutzern vertraut ist. Hier ist eine vollständige Liste der KnownMonikers und laden Sie sich die Erweiterung KnownMonikers Explorer herunter, um die passende für Ihre Szenarien zu finden.

Lassen Sie es sich in Visual Studio nativ anfühlen.

Folgen Sie den gleichen Entwurfsmustern und Prinzipien, die Visual Studio selbst verwendet, damit sich die Erweiterung für die Benutzer natürlich anfühlt. Es reduziert auch Ablenkungen, die durch schlecht gestaltete UI verursacht werden. Stellen Sie sicher, dass alle Schaltflächen, Menüs, Symbolleisten und Toolfenster nur standardmäßig sichtbar sind, wenn sich der Benutzer im richtigen Kontext befindet, um sie zu verwenden. Es gibt einige Faustregeln, die Sie befolgen müssen:

• Fügen Sie nie ein neues Menü der obersten Ebene hinzu (neben "Datei", "Bearbeiten", "...)".
• Es sollten keine Schaltflächen, Menüs und Symbolleisten in Kontexten sichtbar sein, auf die sie nicht angewendet werden.
• Wenn automatisches Laden erforderlich ist (wahrscheinlich nicht), tun Sie es so spät wie möglich.
• Verwenden Sie VisibilityConstraints , um die Sichtbarkeit von Befehlen umzuschalten, anstatt sich auf die automatische Last zu verlassen.

Verwenden Sie richtige Versionsbereiche

Es kann verlockend sein, Versionen von Visual Studio bis zu Visual Studio 2010 zu unterstützen, um sicherzustellen, dass jeder Ihre neue Erweiterung verwenden kann. Das Problem besteht darin, dass dadurch keine APIs mehr verwendet werden können, die nach der Mindestversion der Erweiterung eingeführt wurden. Häufig sind diese neuen APIs wichtig und tragen zur Verbesserung der Leistung und Zuverlässigkeit ihrer Erweiterung sowie von Visual Studio selbst bei.

Hier sind unsere Empfehlungen für die Entscheidung, welche Versionen von Visual Studio unterstützt werden sollen:

• Unterstützen Sie nur die vorherige und aktuelle Version von Visual Studio – unterstützen Sie ältere Versionen nach Möglichkeit nicht.
• Geben Sie keinen unbegrenzten Versionsbereich an, z. B.[16.0,). Weitere Informationen zu Versionsbereichen.