As extensões legais do Visual Studio têm vários recursos principais que os distinguem dos demais. Eles parecem e são realmente bem pensados, funcionais e confiáveis. Além disso, eles fazem o que devem, com o nível de excelência e se encaixam nativamente nas funções internas do Visual Studio.
Para facilitar a escrita de boas extensões, estamos trabalhando com a comunidade para desenvolver uma lista de verificação simples. Existe até um
modelo de problema do GitHub que você pode usar. Neste artigo, veremos 9 regras legais de expansão. Detalhes sob o corte.
As regras
A lista a seguir não está em ordem. Lembre-se de seguir todas as regras para obter melhores resultados.
Regra 1: aderir às regras de cobertura
Adicione o pacote NuGet do
Microsoft.VisualStudio.SDK.Analyzers ao seu projeto VSIX. Isso ajudará você a identificar e resolver erros comuns de segmentação.
Regra 2: adicionar ícone de alta qualidade
Todas as extensões devem ter um ícone associado a elas. Verifique se o ícone é um arquivo .png de alta qualidade com uma resolução de 128 × 128 pixels e um DPI de 96 ou mais. Após adicionar o ícone ao projeto VSIX, registre-o no arquivo .vsixmanifest como um ícone e uma imagem de visualização. O Visual Studio Marketplace usa um ícone maior e o seu será alterado dinamicamente quando exibido no Visual Studio.
Regra 3: Título e Descrição
Estudos mostram que os usuários instalam extensões com mais frequência com nomes descritivos curtos e informações precisas sobre eles. Verifique se o nome captura a essência do que a extensão faz. A descrição no arquivo .vsixmanifest deve criar expectativas sobre o que a extensão faz. No total, uma breve descrição de quais problemas a extensão resolve e quais são suas funções principais.
Regra 4: Escreva uma boa descrição do mercado
Essa é uma das coisas mais importantes que você deve fazer para tornar sua expansão um sucesso. Uma boa descrição consiste em:
- Capturas de tela / GIFs do que será adicionado pela extensão
- Descrição detalhada dos recursos
- Links para detalhes, se necessário
Regra 5: Indique a licença
A licença é exibida no Marketplace, no instalador do VSIX e na caixa de diálogo Gerenciador de Extensões. Sempre especifique uma licença para criar expectativas para os usuários. Considere usar o
choosealicense.com para encontrar a licença certa. O motivo dessa regra é resolver qualquer ambiguidade, o que é importante para muitos usuários do Visual Studio.
Regra 6: adicione um aviso de privacidade
Se a extensão coletar dados, como telemetria, adicione uma observação sobre isso na descrição.
Regra 7: Use KnownMonikers sempre que possível
O Visual Studio vem com milhares de ícones disponíveis na coleção
KnownMonikers . Ao adicionar ícones aos botões, verifique: talvez você possa usar os ícones conhecidos do KnownMonikers, porque eles fazem parte da linguagem de design familiar aos usuários do Visual Studio. Aqui está uma
lista completa
dos KnownMonikers , e você também pode usar a extensão
KnownMonikers Explorer para encontrar a que mais se adequa aos seus scripts.
Regra 8: crie um senso de extensão nativa
Siga os mesmos padrões e princípios de design que o próprio Visual Studio usa. Isso torna a extensão natural para os usuários. Também reduz as distrações causadas por uma interface de usuário mal projetada. Certifique-se de que todos os botões, menus, barras de ferramentas e janelas de ferramentas estejam visíveis por padrão somente quando o usuário estiver no contexto certo para usá-los. Existem várias regras:
- Nunca adicione um novo menu de nível superior (ao lado de Arquivo, Editar etc.)
- Nenhum botão, menu ou barra de ferramentas deve estar visível em contextos aos quais eles não pertencem.
- Se você precisar de carregamento automático (provavelmente não), faça-o o mais rápido possível.
- Use VisibilityConstraints para alternar a visibilidade do comando em vez de confiar no carregamento automático
Regra 9: use os intervalos de versão corretos
Pode ser tentador oferecer suporte a versões do Visual Studio até o Visual Studio 2010, para que todos possam usar sua nova extensão. O problema é que você não pode mais usar as APIs introduzidas depois da versão antiga suportada pela extensão. Geralmente, essas novas APIs são importantes e ajudam a melhorar o desempenho e a confiabilidade da extensão e do próprio Visual Studio.
Aqui estão nossas diretrizes para decidir quais versões do Visual Studio dar suporte:
- Suporte apenas versões anteriores e atuais do Visual Studio - se possível, não suporte versões anteriores
- Não especifique o intervalo de versões disponíveis. Por exemplo. [16,0). Saiba mais sobre as versões aqui .
Sua opinião
O que você acha desta lista de verificação? Você concorda com as regras? Compartilhe seus pensamentos abaixo nos comentários ou no
repositório do GitHub . Espero que a lista de verificação o ajude a criar extensões interessantes que se tornarão realmente populares.