Bonnes pratiques case activée list pour publier une extension Visual Studio

Voici une liste des éléments à mémoriser avant de publier votre extension Visual Studio.

La vidéo suivante présente les meilleures pratiques pour vous assurer que votre extension est la meilleure qu’elle puisse être.

Respecter les règles de threading

Ajoutez le package NuGet Microsoft.VisualStudio.SDK.Analyzers à votre projet VSIX, ce qui vous aidera à découvrir et à corriger les violations courantes des meilleures pratiques en matière de thread.

Ajouter une icône de haute qualité

Toutes les extensions doivent avoir une icône associée. Vérifiez que l’icône est un fichier .png de haute qualité avec la taille de 90 x 90 pixels en 96 ppp ou plus. Après avoir ajouté l’icône à votre projet VSIX, inscrivez-la dans le fichier .vsixmanifest en tant qu’icône et image d’aperçu.

Nom et description

Les études montrent que les extensions portant un nom court et descriptif et une description précise sont plus susceptibles d’être installées par les utilisateurs. Assurez-vous que le nom reflète l’essence de ce que fait l’extension. La brève description dans le fichier .vsixmanifest doit définir les attentes quant à ce que fait l’extension. Ainsi, une brève mention des problèmes qu’il résout et quelles fonctionnalités principales il a sont clés.

Écrire une bonne description de la Place de marché

Il s’agit de l’une des choses les plus importantes que vous devez faire pour réussir votre extension. Une bonne description se compose des éléments suivants :

• Captures d’écran/GIF animées de l’interface utilisateur ajoutée par l’extension.
• Description détaillée des fonctionnalités individuelles.
• Liens vers plus de détails le cas échéant.

Ajouter une licence

Cette licence s’affiche sur la Place de marché, dans le programme d’installation de VSIX et dans la boîte de dialogue Extensions et Mises à jour... . Une licence doit toujours être spécifiée pour définir les attentes des utilisateurs. Utilisez choosealicense.com pour vous aider à trouver la licence appropriée. Une licence est importante pour aider à supprimer toutes les questions et ambiguïtés, ce qui est important pour de nombreux utilisateurs de Visual Studio.

Ajouter une notification de confidentialité

Si l’extension collecte des données telles que la télémétrie ou d’une autre façon communique avec un point de terminaison distant, ajoutez une note à ce sujet dans la description.

Utiliser KnownMonikers lorsque cela est possible

Visual Studio est fourni avec des milliers d’icônes disponibles dans la collection KnownMonikers . Lorsque vous ajoutez des icônes aux boutons de commande, vérifiez si vous pouvez utiliser les icônes KnownMonikers existantes, car elles font partie d’un langage de conception familier aux utilisateurs de Visual Studio. Voici une liste complète des KnownMonikers et récupérez l’extension KnownMonikers Explorer pour trouver la bonne solution pour vos scénarios.

Faire en sorte qu’il soit natif de VS

Suivez les mêmes modèles et principes de conception que Visual Studio lui-même utilise pour rendre l’extension naturelle pour les utilisateurs. Elle réduit également les distractions causées par une interface utilisateur mal conçue. Assurez-vous que tous les boutons, menus, barres d’outils et fenêtres d’outils ne sont visibles par défaut que lorsque l’utilisateur se trouve dans le contexte approprié pour les utiliser. Il existe quelques règles de pouce à suivre :

• N’ajoutez jamais de nouveau menu de niveau supérieur (en regard de Fichier, Modifier, ...).
• Aucun bouton, menus et barres d’outils ne doit être visible dans les contextes auxquels ils ne s’appliquent pas.
• Si la charge automatique est nécessaire (ce n’est probablement pas le cas), faites-la aussi tard que possible.
• Utilisez VisibilityConstraints pour activer la visibilité des commandes au lieu de vous appuyer sur la charge automatique.

Utiliser des plages de versions appropriées

Il peut être tentant de prendre en charge les versions de Visual Studio jusqu’à Visual Studio 2010 pour vous assurer que tout le monde peut utiliser votre nouvelle extension. Le problème avec cela, c’est qu’en procédant ainsi, il n’est plus possible d’utiliser d’API introduites plus tard que cette version minimale prise en charge par l’extension. Souvent, ces nouvelles API sont importantes et aident à améliorer les performances et la fiabilité de votre extension ainsi que Visual Studio lui-même.

Voici nos recommandations pour déterminer les versions de Visual Studio à prendre en charge :

• Prise en charge uniquement de la version précédente et actuelle de Visual Studio : ne prennent pas en charge les versions antérieures si possible.
• Ne spécifiez pas de plage de versions ouverte, par exemple.[16.0,) En savoir plus sur les plages de versions.