Рекомендации проверка list для публикации расширения Visual Studio

Ниже приведен список вещей, которые необходимо помнить перед публикацией расширения Visual Studio.

В следующем видео приведены рекомендации по обеспечению того, чтобы расширение было лучшим.

Соблюдение правил потоков

Добавьте пакет NuGet Microsoft.VisualStudio.SDK.Analyzers в проект VSIX, который поможет вам обнаружить и устранить распространенные нарушения рекомендаций по потоку.

Значок добавления высокого качества

Все расширения должны иметь значок, связанный с ним. Убедитесь, что значок является высококачественным PNG-файлом размером 90x90 пикселей в 96 DPI или более. После добавления значка в проект VSIX зарегистрируйте его в vsixmanifest-файле как изображение значка и предварительного просмотра.

Имя и описание

Исследования показывают, что расширения с коротким и описательным именем и точным описанием, скорее всего, будут установлены пользователями. Убедитесь, что имя отражает суть того, что делает расширение. Краткое описание в vsixmanifest-файле должно задать ожидания по тому, что делает расширение. Таким образом, краткий упоминание о том, какие проблемы он решает и какие основные функции он имеет ключ.

Написание хорошего описания Marketplace

Это одна из самых важных вещей, которые необходимо сделать, чтобы сделать расширение успешным. Хорошее описание состоит из следующих элементов:

• Снимок экрана: анимированные GIF-файлы пользовательского интерфейса, добавленные расширением.
• Подробное описание отдельных функций.
• Ссылки на дополнительные сведения, если это применимо.

Добавление лицензии

Эта лицензия будет отображаться в Marketplace в установщике VSIX и в диалоговом окне расширения и Обновления.... Лицензия всегда должна быть указана, чтобы задать ожидания для пользователей. Используйте choosealicense.com , чтобы помочь вам найти нужную лицензию. Лицензия важна для удаления любых вопросов и неоднозначности, что важно для многих пользователей Visual Studio.

Добавление уведомления о конфиденциальности

Если расширение собирает такие данные, как телеметрия или каким-либо другим способом взаимодействует с удаленной конечной точкой, добавьте в описание заметку.

Использование известныхmonikers, когда это возможно

Visual Studio поставляется с тысячами значков, доступных в коллекции KnownMonikers . При добавлении значков в кнопки команд вы можете использовать существующие значки KnownMonikers, так как они являются частью языка конструктора, знакомого пользователям Visual Studio. Вот полный список ИзвестныхMonikers и захват расширения KnownMonikers Обозреватель, чтобы найти подходящий для ваших сценариев.

Сделать его собственным в VS

Следуйте тем же шаблонам и принципам проектирования, которые сама использует Visual Studio, чтобы сделать расширение естественным для пользователей. Это также снижает отвлекающие факторы, вызванные плохо разработанным пользовательским интерфейсом. Убедитесь, что все кнопки, меню, панели инструментов и окна инструментов отображаются только по умолчанию, если пользователь находится в правильном контексте для их использования. Существуют некоторые правила, которые необходимо выполнить.

• Не добавляйте новое меню верхнего уровня (рядом с файлом, изменением, ...).
• Кнопки, меню и панели инструментов не должны отображаться в контекстах, к ним не применяются.
• Если автоматическая загрузка необходима (вероятно, это не так), сделайте это как можно позже.
• Используйте visibilityConstraints для переключения видимости команд вместо автоматической загрузки.

Использование правильных диапазонов версий

Это может быть заманчиво для поддержки версий Visual Studio до Visual Studio 2010, чтобы убедиться, что все пользователи могут использовать новое расширение. Проблема с этим заключается в том, что при этом больше невозможно использовать какие-либо API, представленные позже этой минимальной версии расширения. Часто эти новые API важны и помогают повысить производительность и надежность расширения, а также самого Visual Studio.

Ниже приведены рекомендации по выбору версий Visual Studio для поддержки:

• Поддержка только предыдущей и текущей версии Visual Studio— если это возможно, не поддерживает более старые версии.
• Не указывайте открытый диапазон версий, например[16.0,). Дополнительные сведения о диапазонах версий.