Lista de verificação de práticas recomendadas para publicar uma extensão do Visual Studio

Aqui está uma lista de coisas para lembrar antes de publicar sua extensão do Visual Studio.

O vídeo a seguir apresenta as melhores práticas para garantir que sua extensão seja a melhor possível.

Siga as regras de encadeamento

Adicione o pacote NuGet Microsoft.VisualStudio.SDK.Analysisers ao seu projeto VSIX, o que ajudará você a descobrir e corrigir violações comuns das práticas recomendadas no threading.

Adicionar ícone de alta qualidade

Todas as extensões devem ter um ícone associado a ela. Verifique se o ícone é um arquivo .png de alta qualidade com o tamanho de 90 x 90 pixels em 96 DPI ou mais. Depois de adicionar o ícone ao seu projeto VSIX, registre-o no arquivo .vsixmanifest como ícone e imagem de 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. Verifique se 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 recursos principais ele tem são fundamentais.

Escrever uma boa descrição do Marketplace

Essa é uma das coisas mais importantes que você deve fazer para que sua extensão seja bem-sucedida. Uma boa descrição consiste em:

• Capturas de tela/GIFs animados da interface do usuário adicionadas pela extensão.
• Descrição detalhada dos recursos individuais.
• Links para mais detalhes, se aplicável.

Adicionar licença

Essa licença será mostrada no Marketplace, no instalador DO VSIX e na caixa de diálogo Extensões e Atualizações... Uma licença sempre deve 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 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 anotação sobre ela na descrição.

Usar o KnownMonikers sempre que possível

O Visual Studio é fornecido com milhares de ícones disponíveis na coleção KnownMonikers . Ao adicionar ícones aos 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 a certa para seus cenários.

Fazer com que ele pareça nativo do VS

Siga os mesmos padrões de design e princípios que o próprio Visual Studio usa para fazer com que a extensão pareça natural para os usuários. Também reduz as distrações causadas pela interface do usuário mal projetada. Verifique se todos os botões, menus, barras de ferramentas e janelas de ferramentas só ficam visíveis por padrão quando o usuário estiver no contexto certo para usá-los. Há algumas regras gerais a seguir:

• Nunca adicione um novo menu de nível superior (ao lado de Arquivo, Editar, ...).
• Nenhum botão, menus e barras de ferramentas deve estar visível em contextos aos quais eles não se aplicam.
• Se a carga automática for necessária (provavelmente não é), faça 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 dar suporte a versões do Visual Studio até o Visual Studio 2010 para garantir que todos possam usar sua nova extensão. O problema é que, ao fazer isso, não é mais possível usar as APIs introduzidas posteriormente à versão mínima à qual a extensão dá suporte. Muitas vezes, essas novas APIs são importantes e ajudam a melhorar o desempenho e a confiabilidade da extensão, bem como do próprio Visual Studio.

Aqui estão nossas recomendações para decidir quais versões do Visual Studio dão suporte:

• Suporte apenas à versão anterior e atual do Visual Studio – não dê suporte a versões mais antigas, se possível.
• Não especifique um intervalo de versão final aberto, por exemplo[16.0,), Saiba mais sobre intervalos de versões.