Compartir a través de

Lista de comprobación de procedimientos recomendados para publicar una extensión de Visual Studio

  • Artículo

Esta es una lista de cosas que debe asegurarse de recordar antes de publicar la extensión de Visual Studio.

En el vídeo siguiente se presentan los procedimientos recomendados para asegurarse de que la extensión es la mejor que puede ser.

Cumplir las reglas de subprocesos

Agregue el paquete NuGet Microsoft.VisualStudio.SDK.Analyzers al proyecto VSIX, lo que le ayudará a detectar y corregir infracciones comunes de los procedimientos recomendados en el subproceso.

Agregar icono de alta calidad

Todas las extensiones deben tener un icono asociado. Asegúrese de que el icono es un archivo .png de alta calidad con el tamaño de 90 x 90 píxeles en 96 PPP o más. Después de agregar el icono al proyecto VSIX, regístrelo en el archivo .vsixmanifest como imagen icono y vista previa.

Nombre y descripción

Los estudios muestran que los usuarios pueden instalar extensiones con un nombre corto y descriptivo y una descripción precisa. Asegúrese de que el nombre refleje la esencia de lo que hace la extensión. La descripción breve del archivo .vsixmanifest debe establecer expectativas en cuanto a lo que hace la extensión. Por lo tanto, una breve mención de los problemas que resuelve y qué características principales tiene son clave.

Escritura de una buena descripción de Marketplace

Esta es una de las cosas más importantes que debe hacer para que la extensión se realice correctamente. Una buena descripción consta de:

  • Capturas de pantalla o GIF animados de la interfaz de usuario agregadas por la extensión.
  • Descripción detallada de las características individuales.
  • Vínculos a más detalles si procede.

Agregar licencia

Esta licencia se mostrará en Marketplace, en el instalador de VSIX y en el cuadro de diálogo Extensiones y Novedades... . Siempre se debe especificar una licencia para establecer las expectativas de los usuarios. Use choosealicense.com para ayudarle a encontrar la licencia adecuada para usted. Una licencia es importante para ayudar a quitar cualquier pregunta y ambigüedad, lo que es importante para muchos usuarios de Visual Studio.

Agregar aviso de privacidad

Si la extensión recopila datos como telemetría o de cualquier otra manera se comunica con un punto de conexión remoto, agregue una nota sobre ella en la descripción.

Usar KnownMonikers siempre que sea posible

Visual Studio se incluye con miles de iconos disponibles en la colección KnownMonikers . Al agregar iconos a botones de comando, vea si puede usar los iconos KnownMonikers existentes, ya que forman parte de un lenguaje de diseño familiar para los usuarios de Visual Studio. Esta es una lista completa de KnownMonikers y toma la extensión KnownMonikers Explorer para encontrar la adecuada para sus escenarios.

Hacer que se sienta nativo de VS

Siga los mismos patrones de diseño y principios que usa Visual Studio para 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 están visibles de forma predeterminada cuando el usuario está en el contexto adecuado para usarlos. Hay algunas reglas generales que se deben seguir:

  • Nunca agregue un nuevo menú de nivel superior (junto a Archivo, Editar, ...).
  • No se deben ver botones, menús ni barras de herramientas en contextos a los que no se aplican.
  • Si es necesario cargar automáticamente (probablemente no lo sea), házlo lo más tarde posible.
  • Use VisibilityConstraints para alternar la visibilidad de los comandos en lugar de confiar en la carga automática.

Uso de intervalos de versiones adecuados

Puede resultar tentador admitir versiones de Visual Studio hasta Visual Studio 2010 para asegurarse de que todos los usuarios pueden usar la nueva extensión. El problema con eso es que, al hacerlo, ya no es posible usar ninguna API introducida más adelante de esa 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 de la extensión, así como de Visual Studio.

Estas son nuestras recomendaciones para decidir qué versiones de Visual Studio admitir:

  • Admitir solo la versión anterior y actual de Visual Studio: no admita versiones anteriores si es posible.
  • No especifique un intervalo de versiones abierto, por ejemplo,[16.0,) . Obtenga más información sobre los intervalos de versiones.