Lista de verificação de práticas recomendadas para publicar uma extensão do Visual Studio
Aqui está uma lista de coisas que você deve lembrar antes de publicar sua extensão do Visual Studio.
O vídeo a seguir apresenta as práticas recomendadas para garantir que sua extensão seja a melhor possível.
Aderir às regras de threading
Adicione o pacote NuGet Microsoft.VisualStudio.SDK.Analyzers ao seu projeto VSIX, que o ajudará a descobrir e corrigir violações comuns das práticas recomendadas de threading.
Adicionar ícone de alta qualidade
Todas as extensões devem ter um ícone associado a ele. Verifique se o ícone é um arquivo .png de alta qualidade com o tamanho de 90x90 pixels em 96 DPI ou mais. Depois de adicionar o ícone ao seu projeto VSIX, registre-o no arquivo .vsixmanifest como a imagem de ícone e visualização.
Nome e descrição
Estudos mostram que extensões com um nome curto e descritivo e uma descrição precisa são mais propensas a serem instaladas pelos usuários. Certifique-se de que o nome reflete a essência do que a extensão faz. A breve descrição no arquivo .vsixmanifest deve definir expectativas sobre o que a extensão faz. Portanto, uma breve menção de quais problemas ele resolve e quais as principais características que ele tem são fundamentais.
Escreva uma boa descrição do Marketplace
Esta é uma das coisas mais importantes que você deve fazer para tornar sua extensão bem-sucedida. Uma boa descrição consiste em:
- Capturas de tela/GIFs animados da interface do usuário adicionados pela extensão.
- Descrição detalhada das características individuais.
- Links para mais detalhes, se aplicável.
Adicionar licença
Esta licença será mostrada no Marketplace, no instalador do VSIX e na caixa de diálogo Extensões e Atualizações... . Uma licença deve sempre ser especificada para definir as expectativas para os usuários. Use choosealicense.com para ajudar a encontrar a licença certa para você. Uma licença é importante para ajudar a remover quaisquer dúvidas e ambiguidades, o que é importante para muitos usuários do Visual Studio.
Adicionar aviso de privacidade
Se a extensão coletar dados como telemetria ou de qualquer outra forma se comunicar com um ponto de extremidade remoto, adicione uma observação sobre isso na descrição.
Use KnownMonikers quando possível
O Visual Studio é fornecido com milhares de ícones que estão disponíveis na coleção KnownMonikers . Ao adicionar ícones a botões de comando, veja se você pode usar os ícones KnownMonikers existentes, pois eles fazem parte de uma linguagem de design familiar aos usuários do Visual Studio. Aqui está uma lista completa de KnownMonikers e pegue a extensão KnownMonikers Explorer para encontrar o certo para seus cenários.
Faça com que ele se sinta nativo para VS
Siga os mesmos padrões e princípios de design que o próprio Visual Studio usa, para fazer a extensão parecer natural para os usuários. Ele também reduz as distrações causadas por uma interface do usuário mal projetada. Certifique-se de que todos os botões, menus, barras de ferramentas e janelas de ferramentas só estejam visíveis por padrão quando o usuário estiver no contexto certo para usá-los. Existem algumas regras básicas a serem seguidas:
- Nunca adicione um novo menu de nível superior (ao lado de Arquivo, Editar, ...).
- Nenhum botão, menu e barra de ferramentas deve estar visível em contextos aos quais não se aplicam.
- Se o carregamento automático for necessário (provavelmente não é), faça-o o mais tarde possível.
- Use VisibilityConstraints para alternar a visibilidade dos comandos em vez de depender do carregamento automático.
Usar intervalos de versão adequados
Pode ser tentador oferecer suporte a versões do Visual Studio até o Visual Studio 2010 para garantir que todos possam usar sua nova extensão. O problema com isso é que, ao fazer isso, não é mais possível usar quaisquer APIs introduzidas depois dessa versão mínima suportada pela extensão. Muitas vezes, essas novas APIs são importantes e ajudam a melhorar o desempenho e a confiabilidade da sua extensão, bem como do próprio Visual Studio.
Aqui estão nossas recomendações para decidir quais versões do Visual Studio oferecer suporte: