Utilidad para colorear el código a mostrar en páginas WEB (gsColorearCodigo)

Deja un comentario

Pues eso… si eres de los que no entran habitualmente en el sitio del Guille (www.elguille.info) y prefieres ver las cosas publicadas aquí en el blog, te diré que ayer publiqué la nueva versión de la utilidad gsColorearCodigo. Y digo NUEVA porque la actualización anterior que publiqué fue hace ya unos 13 añitos de nada 😉 y era para .NET 2.0, mientras que la nueva es para .NET Framework 4.8.

Para facilitar la «coloración» del código a publicar en la WEB esta nueva versión permite copiar el código de Visual Studio, pegarlo en la ventana de la utilidad y generar el código HTML a partir del contenido RTF (ver la figura 1).

Figura 1. La utilidad gsColorearCodigo usando Colorear desde RTF

Esto tiene dos ventajas, la primera es que no es necesario que la utilidad analice el código fuente buscando palabras clave y comentarios, etc. Ya que lo único que tiene que hacer es convertir el código interno del formato RTF y convertirlo en etiquetas span.

Además que al hacerlo así se gana tiempo… te lo digo por experiencia, ya que prácticamente todo el código coloreado que publico desde hace 12 o 13 años lo hago usando esa opción… así que… ya sabes… 😉

Y para muestra, un código coloreado, precisamente el que usé para hacer la captura de la figura 1.

Te lo vuelvo a mostrar en la captura de la figura 2, que es el editor de Visual Studio 2019.

Figura 2. El código a copiar del editor de Visual Studio 2019

Y este es el código HTML generado :

''' <summary>
''' Devuelve la versión de la DLL.
''' Si completa es True, se devuelve también el nombre de la DLL:
''' gsColorear v 1.0.7.0 (para .NET Framework 4.7.2 revisión del dd/MMM/yyyy)
''' </summary>
Public Shared Function Version(Optional completa As Boolean = False) As String
    Dim res = ""
    Dim ensamblado = System.Reflection.Assembly.GetExecutingAssembly
    'Dim m_fvi = System.Diagnostics.FileVersionInfo.GetVersionInfo(ensamblado.Location)
    'res = $"v {m_fvi.FileVersion}"

    Dim versionAttr = ensamblado.GetCustomAttributes(GetType(System.Reflection.AssemblyVersionAttribute), False)
    'DirectCast(DirectCast(versionAttr, System.Reflection.AssemblyVersionAttribute())(0), System.Reflection.AssemblyVersionAt
    Dim vers = If(versionAttr.Length > 0, (TryCast(versionAttr(0), System.Reflection.AssemblyVersionAttribute)).Version,
                                      "1.0.7.0")
    Dim fileVerAttr = ensamblado.GetCustomAttributes(GetType(System.Reflection.AssemblyFileVersionAttribute), False)
    Dim versF = If(fileVerAttr.Length > 0, (TryCast(fileVerAttr(0), System.Reflection.AssemblyFileVersionAttribute)).Version,
                                      "1.0.7.1")

    res = $"v {vers} ({versF})"

    If completa Then
        Dim prodAttr = ensamblado.GetCustomAttributes(GetType(System.Reflection.AssemblyProductAttribute), False)
        Dim producto = If(prodAttr.Length > 0, (TryCast(prodAttr(0), System.Reflection.AssemblyProductAttribute)).Product,
                                        "gsColorear")

        res = $"{producto} {res} (para .NET Framework 4.7.2 revisión del 09/Sep/2020)"
    End If
    Return res
End Function

En este caso, el VS no ha pasado los colores de los tipos (verde azulado), pero en otras ocasiones sí que lo hacía y quedaba guay, pero últimamente no le pasa los datos del color al código que utiliza de RTF… en fin…

 

Nota adicional sobre el coloreado de Visual Studio

Comenté en el párrafo anterior que Visual Studio no pasa los colores de las clases (verde azulado) y antes lo hacía. ¿Lo habrán quitado?

No, no lo han quitado.

Y es que el que lo haga o no depende de una opción en la configuración del editor de textos de Visual Studio.

Esa opción en español es: Usar clasificación precisa.
En inglés es: Use accurate classification.

Y con esos nombres… ¿Quién lo iba a saber?

Para poder cambiar (activar) esa opción lo tienes que hacer en: (ver la captura)
Herramientas>Opciones>Editor de textos>Avanzadas
En inglés sería:
Tools>Options>Text editor>Advanced

Opción para que al copiar el código en Visual Studio coloree también las definiciones de los tipos

Fíjate que también tiene que estar seleccionada la opción Copiar texto enriquecido al copiar o cortar (Copy rich text on copy/cut).

Al pegar el texto coloreado, quedaría así:

''' <summary>
''' Devuelve la versión de la DLL.
''' Si completa es True, se devuelve también el nombre de la DLL:
''' gsColorear v 1.0.7.0 (para .NET Framework 4.7.2 revisión del dd/MMM/yyyy)
''' </summary>
Public Shared Function Version(Optional completa As Boolean = False) As String
    Dim res = ""
    Dim ensamblado = System.Reflection.Assembly.GetExecutingAssembly
    'Dim m_fvi = System.Diagnostics.FileVersionInfo.GetVersionInfo(ensamblado.Location)
    'res = $"v {m_fvi.FileVersion}"

    Dim versionAttr = ensamblado.GetCustomAttributes(GetType(System.Reflection.AssemblyVersionAttribute), False)
    'DirectCast(DirectCast(versionAttr, System.Reflection.AssemblyVersionAttribute())(0), System.Reflection.AssemblyVersionAt
    Dim vers = If(versionAttr.Length > 0, (TryCast(versionAttr(0), System.Reflection.AssemblyVersionAttribute)).Version,
                                      "1.0.7.0")
    Dim fileVerAttr = ensamblado.GetCustomAttributes(GetType(System.Reflection.AssemblyFileVersionAttribute), False)
    Dim versF = If(fileVerAttr.Length > 0, (TryCast(fileVerAttr(0), System.Reflection.AssemblyFileVersionAttribute)).Version,
                                      "1.0.7.1")

    res = $"v {vers} ({versF})"

    If completa Then
        Dim prodAttr = ensamblado.GetCustomAttributes(GetType(System.Reflection.AssemblyProductAttribute), False)
        Dim producto = If(prodAttr.Length > 0, (TryCast(prodAttr(0), System.Reflection.AssemblyProductAttribute)).Product,
                                        "gsColorear")

        res = $"{producto} {res} (para .NET Framework 4.7.2 revisión del 09/Sep/2020)"
    End If
    Return res
End Function

 

Lo que si hace es usar la coloración de las cadenas con los argumentos de las cadenas interpoladas (las que se usan poniendo un signo dólar delante del inicio de las comillas dobles) que utiliza la coloración de Visual Studio, mientras que si lo haces con el comando Colorear en HTML, todo el contenido de la cadena estaría de color rojo, tal como puedes ver a continuación.

        res = $"{producto} {res} (para .NET Framework 4.7.2 revisión del 09/Sep/2020)"
    End If
    Return res
End Function

Aunque con la utilidad puedes configurar los colores y usar Colorear en HTML y mostrar el código con el look ese que tanto le gusta a «los otros» 😉

''' <summary>
''' Devuelve la versión de la DLL.
''' Si completa es True, se devuelve también el nombre de la DLL:
''' gsColorear v 1.0.7.0 (para .NET Framework 4.7.2 revisión del dd/MMM/yyyy)
''' </summary>
Public Shared Function Version(Optional completa As Boolean = False) As String
    Dim res = ""
    Dim ensamblado = System.Reflection.Assembly.GetExecutingAssembly
    'Dim m_fvi = System.Diagnostics.FileVersionInfo.GetVersionInfo(ensamblado.Location)
    'res = $"v {m_fvi.FileVersion}"

    Dim versionAttr = ensamblado.GetCustomAttributes(GetType(System.Reflection.AssemblyVersionAttribute), False)
    'DirectCast(DirectCast(versionAttr, System.Reflection.AssemblyVersionAttribute())(0), System.Reflection.AssemblyVersionAt
    Dim vers = If(versionAttr.Length > 0, (TryCast(versionAttr(0), System.Reflection.AssemblyVersionAttribute)).Version,
                                      "1.0.7.0")
    Dim fileVerAttr = ensamblado.GetCustomAttributes(GetType(System.Reflection.AssemblyFileVersionAttribute), False)
    Dim versF = If(fileVerAttr.Length > 0, (TryCast(fileVerAttr(0), System.Reflection.AssemblyFileVersionAttribute)).Version,
                                      "1.0.7.1")

    res = $"v {vers} ({versF})"

    If completa Then
        Dim prodAttr = ensamblado.GetCustomAttributes(GetType(System.Reflection.AssemblyProductAttribute), False)
        Dim producto = If(prodAttr.Length > 0, (TryCast(prodAttr(0), System.Reflection.AssemblyProductAttribute)).Product,
                                        "gsColorear")

        res = $"{producto} {res} (para .NET Framework 4.7.2 revisión del 09/Sep/2020)"
    End If
    Return res
End Function

Por si te interesa, aquí tienes los colores a usar y el valor de «pre» para conseguir ese coloreado del código:

Tag del formato <pre>:
<pre style=»background-color:black; color:#dcdcdc»>
Color texto: d69d85
Color comentario: 57a64a
Color documentación (XML): 57a64a
Color instrucciones: 569cd6

Bueno, no te canso más… espero que te sea de utilidad y la uses si necesitas colorear código para publicar en una sitio web.

El código fuente y el instalador de ClickOnce lo encontrarás en la página que publiqué en elGuille.info.

Este es el enlace para instalar la utilidad con ClickOnce y este otro es para que veas la página de la utilidad gsColorearCodigo en elguille.info.

 

¡Hasta pronto y que lo colorees bien! 🙂

 

Nos vemos.
Guillermo

P.S.
Ahora que veo el código publicado… no queda mal el fondo negro con el resto de colores… lo mismo modifico la utilidad de colorear para que al colorear desde RTF utilice esos colores en vez de los «predeterminados», que yo creo que son los que recoge del código RTF de Visual Studio, pero lo mismo es fácil de cambiarlos.
Si lo logro, ya te enterarás con una nueva actualización 😉

Deja una respuesta

Tu dirección de correo electrónico no será publicada. Los campos obligatorios están marcados con *