Lista kontrolna najlepszych rozwiązań dotycząca publikowania rozszerzenia programu Visual Studio

Oto lista rzeczy, które należy zapamiętać przed opublikowaniem rozszerzenia programu Visual Studio.

W poniższym filmie wideo przedstawiono najlepsze rozwiązania, aby upewnić się, że rozszerzenie jest najlepsze.

Przestrzegaj reguł wątkowania

Dodaj pakiet NuGet Microsoft.VisualStudio.SDK.Analyzers do projektu VSIX, który pomoże Ci odkryć i naprawić typowe naruszenia najlepszych rozwiązań dotyczących wątków.

Dodawanie ikony wysokiej jakości

Wszystkie rozszerzenia powinny mieć skojarzoną ikonę. Upewnij się, że ikona jest wysokiej jakości plikiem .png o rozmiarze 90x90 pikseli w rozdzielczości 96 DPI lub więcej. Po dodaniu ikony do projektu VSIX zarejestruj go w pliku vsixmanifest jako obraz Ikona i Podgląd.

Nazwa i opis

Badania pokazują, że rozszerzenia z krótką i opisową nazwą i dokładnym opisem są bardziej prawdopodobne, aby były instalowane przez użytkowników. Upewnij się, że nazwa odzwierciedla istotę tego, co robi rozszerzenie. Krótki opis w pliku vsixmanifest powinien określać oczekiwania co do tego, co robi rozszerzenie. Dlatego krótka wzmianka o tym, jakie problemy rozwiązuje i jakie główne funkcje ma, są kluczowe.

Pisanie dobrego opisu witryny Marketplace

Jest to jedna z najważniejszych rzeczy, które należy wykonać, aby rozszerzenie powiodło się. Dobry opis składa się z następujących elementów:

• Zrzuty ekranu/animowane pliki GIF interfejsu użytkownika dodanego przez rozszerzenie.
• Szczegółowy opis poszczególnych funkcji.
• Linki do dodatkowych szczegółów, jeśli ma to zastosowanie.

Dodawanie licencji

Ta licencja będzie wyświetlana w witrynie Marketplace, w instalatorze VSIX i w oknie dialogowym Rozszerzenia i aktualizacje... Należy zawsze określić licencję, aby określić oczekiwania użytkowników. Użyj choosealicense.com , aby znaleźć odpowiednią licencję. Licencja jest ważna, aby pomóc usunąć wszelkie pytania i niejednoznaczność, co jest ważne dla wielu użytkowników programu Visual Studio.

Dodawanie powiadomienia o ochronie prywatności

Jeśli rozszerzenie zbiera dane, takie jak dane telemetryczne lub w jakikolwiek inny sposób komunikuje się z zdalnym punktem końcowym, dodaj do niego notatkę w opisie.

Użyj znanych monikerów, jeśli jest to możliwe

Program Visual Studio jest dostarczany z tysiącami ikon dostępnych w kolekcji KnownMonikers . Podczas dodawania ikon do przycisków poleceń sprawdź, czy możesz użyć istniejących ikon KnownMonikers, ponieważ stanowią część języka projektowania znanego użytkownikom programu Visual Studio. Oto pełna lista KnownMonikers i pobierz rozszerzenie KnownMonikers Explorer, aby znaleźć odpowiedni do Twoich scenariuszy.

Spraw, aby wyglądało naturalnie dla VS

Postępuj zgodnie z tymi samymi wzorcami i zasadami projektowania używanymi przez program Visual Studio, aby rozszerzenie było naturalne dla użytkowników. Zmniejsza to również rozproszenie uwagi spowodowane przez słabo zaprojektowany interfejs użytkownika. Upewnij się, że wszystkie przyciski, menu, paski narzędzi i okna narzędzi są widoczne tylko domyślnie, gdy użytkownik znajduje się w odpowiednim kontekście, aby z nich korzystać. Istnieją pewne reguły, które należy przestrzegać:

• Nie dodawaj nowego menu najwyższego poziomu (obok pozycji Plik, Edytuj, ...).
• Nie powinny być widoczne żadne przyciski, menu i paski narzędzi w kontekstach, do których nie mają zastosowania.
• Jeśli automatyczne ładowanie jest konieczne (prawdopodobnie nie jest), zrób to tak późno, jak to możliwe.
• Użyj ograniczeń widoczności , aby przełączać widoczność poleceń zamiast polegać na automatycznym ładowaniu.

Używanie odpowiednich zakresów wersji

Może to być kuszące do obsługi wersji Visual Studio aż do wersji Visual Studio 2010, aby zapewnić, że każdy będzie mógł używać nowego rozszerzenia. Problem polega na tym, że w ten sposób nie jest już możliwe użycie żadnych interfejsów API wprowadzonych później niż ta minimalna wersja obsługiwana przez rozszerzenie. Często te nowe interfejsy API są ważne i pomagają zwiększyć wydajność i niezawodność zarówno rozszerzenia, jak i samego programu Visual Studio.

Poniżej przedstawiono nasze zalecenia dotyczące decydowania o tym, jakie wersje programu Visual Studio mają być obsługiwane:

• Obsługa tylko poprzedniej i bieżącej wersji programu Visual Studio — nie obsługują starszych wersji, jeśli to możliwe.
• Nie określaj otwartego zakresu wersji, na przykład[16.0,). Dowiedz się więcej o zakresach wersji.