Coole Visual Studio-Erweiterungen verfügen über mehrere wichtige Funktionen, die sie von den anderen unterscheiden. Sie sehen aus und sind eigentlich gut durchdacht, funktional und zuverlässig. Darüber hinaus tun sie das, was sie sollten, auf höchstem Niveau und passen nativ in die internen Funktionen von Visual Studio.
Um das Schreiben guter Erweiterungen zu vereinfachen, arbeiten wir mit der Community zusammen, um eine einfache Checkliste zu entwickeln. Es gibt sogar eine
GitHub-Problemvorlage , die Sie verwenden können. In diesem Artikel werden 9 coole Erweiterungsregeln vorgestellt. Details unter dem Schnitt.
Die Regeln
Die folgende Liste ist nicht in Ordnung. Denken Sie daran, alle Regeln zu befolgen, um die besten Ergebnisse zu erzielen.
Regel 1: Beachten Sie die Deckungsregeln
Fügen Sie Ihrem VSIX-Projekt das NuGet-Paket
Microsoft.VisualStudio.SDK.Analyzers hinzu. Auf diese Weise können Sie häufig auftretende Threading-Fehler identifizieren und beheben.
Regel 2: Fügen Sie ein qualitativ hochwertiges Symbol hinzu
Allen Erweiterungen muss ein Symbol zugeordnet sein. Stellen Sie sicher, dass das Symbol eine hochwertige PNG-Datei mit einer Auflösung von 128 × 128 Pixel und einer DPI von 96 oder mehr ist. Registrieren Sie das Symbol nach dem Hinzufügen zum VSIX-Projekt in der .vsixmanifest-Datei als Symbol und Vorschaubild. Der Visual Studio-Marktplatz verwendet ein größeres Symbol, und Ihr Symbol ändert sich dynamisch, wenn es in Visual Studio angezeigt wird.
Regel 3: Titel und Beschreibung
Studien zeigen, dass Benutzer häufiger Erweiterungen mit kurzen beschreibenden Namen und genauen Informationen über sie installieren. Stellen Sie sicher, dass der Name die Essenz der Erweiterung erfasst. Die Beschreibung in der .vsixmanifest-Datei sollte Erwartungen hinsichtlich der Funktionsweise der Erweiterung wecken. Insgesamt eine kurze Beschreibung, welche Probleme die Erweiterung löst und welche Funktionen sie hat.
Regel 4: Schreiben Sie eine gute Marktplatzbeschreibung
Dies ist eines der wichtigsten Dinge, die Sie tun müssen, um Ihre Expansion zum Erfolg zu führen. Eine gute Beschreibung besteht aus:
- Screenshots / GIFs von dem, was von der Erweiterung hinzugefügt wird
- Detaillierte Funktionsbeschreibung
- Links zu Details, falls erforderlich
Regel 5: Geben Sie die Lizenz an
Die Lizenz wird auf dem Marktplatz, im VSIX-Installationsprogramm und im Dialogfeld Erweiterungs-Manager angezeigt. Geben Sie immer eine Lizenz an, um Erwartungen für Benutzer zu schaffen. Verwenden Sie
choosealicense.com , um die richtige Lizenz zu finden. Der Grund für diese Regel besteht darin, Unklarheiten zu beseitigen, die für viele Visual Studio-Benutzer wichtig sind.
Regel 6: Fügen Sie eine Datenschutzerklärung hinzu
Wenn die Erweiterung Daten wie Telemetrie erfasst, fügen Sie in der Beschreibung einen Hinweis dazu hinzu.
Regel 7: Verwenden Sie nach Möglichkeit KnownMonikers
Visual Studio enthält Tausende von
Symbolen , die in der
KnownMonikers- Sammlung verfügbar sind. Aktivieren Sie beim Hinzufügen von Symbolen zu Schaltflächen Folgendes: Möglicherweise können Sie vorhandene KnownMonikers-Symbole verwenden, da diese Teil der Designsprache sind, die Visual Studio-Benutzern vertraut ist. Hier finden Sie eine vollständige
Liste der KnownMonikers . Sie können auch die
KnownMonikers Explorer- Erweiterung verwenden, um die für Ihre Skripte
geeignete zu finden.
Regel 8: Erstellen Sie ein Gefühl der nativen Erweiterung
Befolgen Sie dieselben Muster und Entwurfsprinzipien, die Visual Studio selbst verwendet. Dies macht die Erweiterung für Benutzer natürlich. Es reduziert auch Ablenkungen, die durch eine schlecht gestaltete Benutzeroberfläche verursacht werden. Stellen Sie sicher, dass alle Schaltflächen, Menüs, Symbolleisten und Werkzeugfenster standardmäßig nur sichtbar sind, wenn sich der Benutzer im richtigen Kontext für ihre Verwendung befindet. Es gibt verschiedene Regeln:
- Fügen Sie niemals ein neues Menü der obersten Ebene hinzu (neben Datei, Bearbeiten usw.).
- In Kontexten, zu denen sie nicht gehören, sollten keine Schaltflächen, Menüs oder Symbolleisten sichtbar sein.
- Wenn Sie ein automatisches Laden benötigen (höchstwahrscheinlich nicht), tun Sie dies so schnell wie möglich.
- Verwenden Sie VisibilityConstraints, um die Befehlssichtbarkeit umzuschalten, anstatt sich auf das automatische Laden zu verlassen
Regel 9: Verwenden Sie die richtigen Versionsbereiche
Es kann verlockend sein, Versionen von Visual Studio bis Visual Studio 2010 zu unterstützen, damit jeder Ihre neue Erweiterung verwenden kann. Das Problem ist, dass Sie die später eingeführten APIs nicht mehr als die alte Version verwenden können, die die Erweiterung unterstützt. Oft sind diese neuen APIs wichtig und tragen dazu bei, die Leistung und Zuverlässigkeit Ihrer Erweiterung und von Visual Studio selbst zu verbessern.
Hier sind unsere Richtlinien für die Entscheidung, welche Versionen von Visual Studio unterstützt werden sollen:
- Unterstützt nur frühere und aktuelle Versionen von Visual Studio. Wenn möglich, unterstützen Sie ältere Versionen nicht
- Geben Sie nicht den Bereich der verfügbaren Versionen an. Zum Beispiel. [16.0,). Weitere Informationen zu den Versionen finden Sie hier .
Ihre Meinung
Was halten Sie von dieser Checkliste? Stimmen Sie den Regeln zu? Bitte teilen Sie Ihre Gedanken unten in den Kommentaren oder im
GitHub-Repository . Ich hoffe, die Checkliste hilft Ihnen dabei, coole Erweiterungen zu erstellen, die sehr beliebt werden.