Großartige Visual Studio-Erweiterungen weisen einige wichtige Funktionen auf, die sie von den anderen unterscheiden. Sie sehen gut aus und fühlen sich gut an, sind performant und zuverlässig, machen das, was sie bewerben, perfekt und fügen sich auf natürliche Weise in die eigenen Funktionen von Visual Studio ein.
Um das Schreiben großartiger Erweiterungen zu vereinfachen, haben wir mit der Erweiterungs-Community zusammengearbeitet, um eine einfache Checkliste zu erstellen, der Sie folgen können. Es gibt sogar eine
GitHub-Problemvorlage, die Sie verwenden können, damit Sie daran denken, die Checkliste durchzugehen.
Regeln
Die folgende Liste ist in keiner bestimmten Reihenfolge. Denken Sie daran, alle Elemente zu vervollständigen, um die besten Ergebnisse zu erzielen.
Regel 1: Threading-Regeln einhalten
Fügen Sie Ihrem VSIX-Projekt das NuGet-Paket
Microsoft.VisualStudio.SDK.Analyzers hinzu. Auf diese Weise können Sie häufige Verstöße gegen Best Practices in Bezug auf Threading erkennen und beheben.
Regel 2: Fügen Sie ein qualitativ hochwertiges Symbol hinzu
Allen Erweiterungen sollte ein Symbol zugeordnet sein. Stellen Sie sicher, dass es sich bei dem Symbol um eine hochwertige PNG-Datei mit einer Größe von 128 × 128 Pixel in 96 DPI oder mehr handelt. 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. Der Visual Studio Marketplace verwendet das größere Symbol und wird dynamisch in der Größe geändert, wenn es in Visual Studio angezeigt wird.
Regel 3: Name und Beschreibung
Studien zeigen, dass Benutzer eher Erweiterungen mit kurzen und beschreibenden Namen und genauen Beschreibungen installieren. Stellen Sie sicher, dass der Name die Essenz der Erweiterung widerspiegelt. Die Beschreibung in der .vsixmanifest-Datei sollte Erwartungen hinsichtlich der Funktionsweise der Erweiterung festlegen. Daher ist eine kurze Erwähnung, welche Probleme es löst und welche Hauptmerkmale es hat, der Schlüssel.
Regel 4: Schreiben Sie eine gute Marktplatzbeschreibung
Dies ist eines 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 Funktionen
- Links zu weiteren Details, falls zutreffend
Regel 5: Lizenz hinzufügen
Die Lizenz wird auf dem Marktplatz, im VSIX-Installationsprogramm und im Dialogfeld "Erweiterungs-Manager" angezeigt. Geben Sie immer eine Lizenz an, um die Erwartungen für die Benutzer festzulegen. Verwenden Sie
choosealicense.com , um die richtige Lizenz für Sie zu finden. Der Grund für diese Regel besteht darin, Unklarheiten zu beseitigen, die für viele Visual Studio-Benutzer wichtig sind.
Regel 6: Datenschutzhinweis hinzufügen
Wenn die Erweiterung Daten wie Telemetrie sammelt oder auf andere Weise mit einem Remote-Endpunkt kommuniziert, fügen Sie in der Beschreibung einen Hinweis dazu hinzu.
Regel 7: Verwenden Sie nach Möglichkeit KnownMonikers
Visual Studio wird mit Tausenden von
Symbolen geliefert, die in der
KnownMonikers- Sammlung verfügbar sind. Überprüfen Sie beim Hinzufügen von Symbolen zu Befehlsschaltflächen, ob Sie die vorhandenen KnownMonikers-Symbole verwenden können, da diese Teil einer Designsprache sind, die den Visual Studio-Benutzern vertraut ist. Hier finden Sie eine vollständige
Liste der KnownMonikers und die
KnownMonikers Explorer- Erweiterung, um die richtige für Ihre Szenarien zu finden.
Regel 8: Fühlen Sie sich in VS heimisch
Befolgen Sie dieselben Entwurfsmuster und -prinzipien, die Visual Studio selbst verwendet. Dadurch fühlt sich die Erweiterung für die Benutzer natürlich an. Es reduziert auch Ablenkungen durch schlecht gestaltete Benutzeroberfläche. Stellen Sie sicher, dass alle Schaltflächen, Menüs, Symbolleisten und Werkzeugfenster standardmäßig nur sichtbar sind, wenn sich der Benutzer im richtigen Kontext befindet, um sie zu verwenden. Es gibt einige Faustregeln zu befolgen:
- Fügen Sie niemals ein neues Menü der obersten Ebene hinzu (neben Datei, Bearbeiten usw.).
- In Kontexten, auf die sie nicht zutreffen, sollten keine Schaltflächen, Menüs und Symbolleisten sichtbar sein
- Wenn ein automatisches Laden erforderlich ist (wahrscheinlich nicht), tun Sie dies so spät wie möglich.
- Verwenden Sie VisibilityConstraints, um die Sichtbarkeit von Befehlen umzuschalten, anstatt sich auf das automatische Laden zu verlassen
Regel 9: Verwenden Sie geeignete 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 dabei ist, dass auf diese Weise keine APIs mehr verwendet werden können, die später als die von der Erweiterung unterstützte Mindestversion eingeführt wurden. Oft sind diese neuen APIs wichtig und tragen dazu bei, die Leistung und Zuverlässigkeit sowohl Ihrer Erweiterung als auch von Visual Studio selbst zu verbessern.
Hier sind unsere Empfehlungen für die Entscheidung, welche Versionen von Visual Studio unterstützt werden sollen:
- Unterstützt nur die vorherige und aktuelle Version von Visual Studio - unterstützt nach Möglichkeit keine älteren Versionen
- Geben Sie keinen offenen Versionsbereich an. ZB [16.0,]. Erfahren Sie mehr über Versionsbereiche .
Deine Gedanken
Was halten Sie von dieser Checkliste? Stimmen Sie den Regeln zu? Bitte teilen Sie uns Ihre Meinung in den Kommentaren unten oder auf dem
GitHub-Repo für die Checkliste mit . Ich hoffe, dies macht es ein wenig einfacher, Ihren Erweiterungen das gewisse Extra zu geben, das sie von den anderen unterscheidet.