Las excelentes extensiones de Visual Studio comparten algunas características clave que las distinguen del resto. Se ven y se sienten bien diseñados, son efectivos y confiables, hacen lo que anuncian a la perfección y se mezclan naturalmente entre las características propias de Visual Studio.
Para facilitar la escritura de grandes extensiones, hemos trabajado con la comunidad de extensibilidad para crear una lista de verificación simple a seguir. Incluso hay una
plantilla de problema de GitHub que puede usar para que recuerde revisar la lista de verificación.
Reglas
La siguiente lista no está en un orden específico. Recuerde completar todos los artículos para obtener mejores resultados.
Regla 1: adherirse a las reglas de enhebrado
Agregue el paquete
Microsoft.VisualStudio.SDK.Analyzers NuGet a su proyecto VSIX. Esto lo ayudará a descubrir y corregir infracciones comunes de las mejores prácticas en materia de subprocesos.
Regla 2: Agregar icono de alta calidad
Todas las extensiones deben tener un icono asociado. Asegúrese de que el icono sea un archivo .png de alta calidad con un tamaño de 128 × 128 píxeles en 96 DPI o más. Después de agregar el ícono a su proyecto VSIX, regístrelo en el archivo .vsixmanifest como el ícono y la imagen de vista previa. Visual Studio Marketplace utiliza el ícono más grande y cambiará de tamaño dinámicamente cuando se muestre dentro de Visual Studio.
Regla 3: nombre y descripción
Los estudios demuestran que es más probable que los usuarios instalen extensiones con nombres cortos y descriptivos y descripciones precisas. Asegúrese de que el nombre refleje la esencia de lo que hace la extensión. La descripción en el archivo .vsixmanifest debería establecer expectativas sobre lo que hace la extensión. Entonces, una breve mención de qué problemas resuelve y qué características principales tiene son clave.
Regla 4: Escribe una buena descripción de Marketplace
Esta es una de las cosas más importantes que debe hacer para que su extensión sea exitosa. Una buena descripción consiste en:
- Capturas de pantalla / GIF animados de la interfaz de usuario añadidos por la extensión
- Descripción detallada de las características individuales.
- Enlaces a más detalles si corresponde
Regla 5: Agregar licencia
La licencia está visible en Marketplace, en el instalador VSIX y en el cuadro de diálogo Administrador de extensiones. Siempre especifique una licencia para establecer las expectativas de los usuarios. Considere usar
choosealicense.com para ayudarlo a encontrar la licencia adecuada para usted. La razón de esta regla es eliminar cualquier ambigüedad, lo cual es importante para muchos usuarios de Visual Studio.
Regla 6: Agregar aviso de privacidad
Si la extensión recopila datos como la telemetría o se comunica de alguna otra manera con un punto final remoto, agregue una nota al respecto en la descripción.
Regla 7: Use KnownMonikers cuando sea posible
Visual Studio se entrega con miles de iconos que están disponibles en la colección
KnownMonikers . Cuando agregue íconos a los botones de comando, vea si puede usar los íconos existentes de KnownMonikers, ya que son parte de un lenguaje de diseño familiar para los usuarios de Visual Studio. Aquí hay una
lista completa
de KnownMonikers y toma la extensión
KnownMonikers Explorer para encontrar la correcta para tus escenarios.
Regla 8: haz que se sienta nativa de VS
Siga los mismos patrones y principios de diseño que usa Visual Studio. Esto hace que la extensión se sienta natural para los usuarios. También reduce las distracciones causadas por una interfaz de usuario mal diseñada. Asegúrese de que todos los botones, menús, barras de herramientas y ventanas de herramientas solo sean visibles de forma predeterminada cuando el usuario esté en el contexto adecuado para usarlos. Hay algunas reglas generales a seguir:
- Nunca agregue un nuevo menú de nivel superior (junto a Archivo, Editar, etc.)
- Ningún botón, menú y barra de herramientas debe ser visible en contextos a los que no se aplica.
- Si la carga automática es necesaria (probablemente no lo sea), hágalo lo más tarde posible.
- Use VisibilityConstraints para alternar la visibilidad de los comandos en lugar de confiar en la carga automática
Regla 9: usar rangos de versión adecuados
Puede ser tentador admitir versiones de Visual Studio hasta Visual Studio 2010 para garantizar que todos puedan usar su nueva extensión. El problema con eso es que al hacerlo, ya no es posible usar ninguna API introducida más tarde que la versión mínima que admite la extensión. A menudo, esas nuevas API son importantes y ayudan a mejorar el rendimiento y la confiabilidad tanto de su extensión como de Visual Studio.
Estas son nuestras recomendaciones para decidir qué versiones de Visual Studio admitir:
- Admite solo la versión anterior y actual de Visual Studio; si es posible, no admite versiones anteriores
- No especifique un rango de versión abierta. Por ejemplo [16.0,). Obtenga más información sobre los rangos de versiones .
Tus pensamientos
¿Qué opinas de esta lista de verificación? ¿Estás de acuerdo con las reglas? Háganos saber sus pensamientos en los comentarios a continuación o en el
repositorio de GitHub para la lista de verificación . Espero que esto haga que sea un poco más fácil darle a tus extensiones algo extra que lo distinga del resto.