Kontrolní seznam osvědčených postupů k publikování rozšíření sady Visual Studio
Tady je seznam věcí, které si před publikováním rozšíření sady Visual Studio nezapomeňte zapamatovat.
Následující video představuje osvědčené postupy, které zajistí, že je vaše rozšíření nejlepší.
Dodržování pravidel podprocesů
Přidejte balíček NuGet Microsoft.VisualStudio.SDK.Analyzers do projektu VSIX, který vám pomůže zjistit a opravit běžná porušení osvědčených postupů pro podprocesy.
Ikona Přidat vysokou kvalitu
Všechna rozšíření by měla mít přidruženou ikonu. Ujistěte se, že je ikona vysoce kvalitním souborem .png s velikostí 90 × 90 pixelů v rozlišení 96 DPI nebo více. Po přidání ikony do projektu VSIX ji zaregistrujte v souboru .vsixmanifest jako obrázek Ikona i Náhled.
Název a popis
Studie ukazují, že uživatelé budou pravděpodobně instalovat rozšíření s krátkým a popisným názvem a přesným popisem. Ujistěte se, že název odráží podstatu toho, co rozšíření dělá. Krátký popis v souboru .vsixmanifest by měl nastavit očekávání o tom, co přípona dělá. Stručný přehled o problémech, které řeší a jaké hlavní funkce má, jsou klíčové.
Napsání dobrého popisu Marketplace
Toto je jedna z nejdůležitějších věcí, které byste měli udělat, aby rozšíření bylo úspěšné. Dobrý popis se skládá z:
- Snímky obrazovky nebo animované gify uživatelského rozhraní přidané rozšířením
- Podrobný popis jednotlivých funkcí
- Odkazy na další podrobnosti, pokud jsou k dispozici.
Přidání licence
Tato licence se zobrazí na Marketplace, v instalačním programu VSIX a v dialogovém okně Rozšíření a Aktualizace... Pro nastavení očekávání pro uživatele by měla být vždy zadána licence. Pomocí choosealicense.com můžete najít správnou licenci. Licence je důležitá k odebrání všech otázek a nejednoznačnosti, což je důležité pro mnoho uživatelů sady Visual Studio.
Přidání oznámení o ochraně osobních údajů
Pokud rozšíření shromažďuje data, jako je telemetrie nebo jiným způsobem, komunikuje se vzdáleným koncovým bodem, přidejte do popisu poznámku.
Pokud je to možné, použijte pole KnownMonikers
Visual Studio se dodává s tisíci ikon, které jsou dostupné v kolekci KnownMonikers . Když přidáváte ikony do příkazových tlačítek, podívejte se, jestli můžete použít existující ikony KnownMonikers, protože jsou součástí jazyka návrhu známého uživatelům sady Visual Studio. Tady je úplný seznam pole KnownMonikers a získejte rozšíření KnownMonikers Explorer , abyste našli ten správný pro vaše scénáře.
Nastavení nativního pro VS
Postupujte podle stejných vzorů a principů návrhu, které sada Visual Studio používá, aby se rozšíření pro uživatele cítilo přirozeně. Snižuje také rušivé prvky způsobené špatně navrženým uživatelským rozhraním. Ujistěte se, že všechna tlačítka, nabídky, panely nástrojů a okna nástrojů jsou ve výchozím nastavení viditelná jenom v případě, že je uživatel ve správném kontextu, aby je používal. Existuje několik pravidel, která je potřeba dodržovat:
- Nikdy nepřidávejte novou nabídku nejvyšší úrovně (vedle souboru, úpravy, ...).
- Žádná tlačítka, nabídky a panely nástrojů by se neměly zobrazovat v kontextech, na které se nevztahují.
- Pokud je potřeba automatické načtení (pravděpodobně není), udělejte to co nejpozději.
- Pomocí omezení viditelnosti můžete přepínat viditelnost příkazů místo toho, abyste se museli spoléhat na automatické načítání.
Použití správných rozsahů verzí
Může být lákavé podporovat verze sady Visual Studio až do sady Visual Studio 2010, aby všichni mohli používat nové rozšíření. Problém s tím spočívá v tom, že už není možné používat žádná rozhraní API zavedená později než tato minimální verze, kterou rozšíření podporuje. Tato nová rozhraní API jsou často důležitá a pomáhají zlepšit výkon a spolehlivost vašeho rozšíření i samotné sady Visual Studio.
Tady jsou naše doporučení pro rozhodování o tom, jaké verze sady Visual Studio mají podporovat:
- Podpora pouze předchozí a aktuální verze sady Visual Studio – pokud je to možné, starší verze nepodporují.
- Nezadávejte například
[16.0,)otevřený rozsah verzí. Přečtěte si další informace o rozsazích verzí.