Impresión bonita

El formato legible (o prettyprinting ) consiste en aplicar diversas convenciones de formato estilístico a archivos de texto , como código fuente , marcado y contenido similar. Estas convenciones de formato pueden implicar el uso de un estilo de sangría , el uso de diferentes colores y tipografías para resaltar elementos sintácticos del código fuente o el ajuste del tamaño, para facilitar la lectura y comprensión del contenido. A los formateadores de código fuente se les suele llamar formateadores o embellecedores de código .

El formato legible generalmente se refiere a mostrar expresiones matemáticas de manera similar a como se escribirían tipográficamente de forma profesional. Por ejemplo, en sistemas de álgebra computacional como Maxima o Mathematica, el sistema puede escribir una salida como "x² + 3 * x" como "${\displaystyle x^{2}+3x}$". Algunas calculadoras gráficas pueden realizar impresión con formato. Dichas calculadoras incluyen la serie Casio 9860 , la serie HP-49/50 y HP Prime , TI-84 Plus , TI-89 , TI-Nspire y la TI-83 Plus con el complemento PrettyPt ^{[ 1 ]} . De manera similar, la TI-84 Plus con el complemento PrettPt o con sistemas operativos habilitados para "MathPrint". Además, varias calculadoras científicas más nuevas están equipadas con pantallas de matriz de puntos capaces de imprimir con formato, como la serie Casio FX-ES (Natural Display), la serie Sharp EL-W (WriteView), HP SmartCalc 300s , TI-30XB y Numworks .

Muchos programas de formato de texto también pueden componer fórmulas matemáticas: TeX se desarrolló específicamente para la composición tipográfica matemática de alta calidad .

El formato legible en los lenguajes de marcado se asocia generalmente con la indentación de etiquetas y cadenas de texto para determinar visualmente la jerarquía y el anidamiento. Si bien las estructuras sintácticas de los lenguajes basados ​​en etiquetas no varían significativamente, la indentación puede variar considerablemente según la interpretación del lenguaje de marcado o los datos que describe.

En MathML , los caracteres de espacio en blanco no reflejan datos, significado o sintaxis más allá de lo requerido por la sintaxis XML . En HTML , los caracteres de espacio en blanco entre etiquetas se consideran texto y se analizan como nodos de texto en el resultado analizado. ^{[ 2 ]} Si bien la indentación puede aplicarse generosamente a un documento MathML, se debe tener suficiente cuidado adicional al formatear un documento HTML para garantizar que no se creen o destruyan nodos de texto adicionales en general cerca del contenido o de los elementos de etiqueta que reflejan el contenido. Esta diferencia en complejidad no es trivial desde la perspectiva de una operación de formateo automatizada donde no se necesitan reglas especiales o casos límite, como en el ejemplo más simple de MathML. El ejemplo de HTML puede requerir una serie de algoritmos progresivos interrelacionados para tener en cuenta varios patrones de elementos de etiqueta y contenido que se ajusten a un estilo uniforme y sea consistente en su aplicación en varias instancias, como lo demuestra el componente de aplicación markup.ts ^{[ 3 ]} utilizado para embellecer HTML, XML y tecnologías relacionadas para la herramienta Pretty Diff .

A los programadores se les enseña a seguir un estilo de formato al escribir el código fuente de un programa , para que el código sea más fácil de leer y comprender. Los estilos varían. Abarcan aspectos como la indentación , los espacios en blanco alrededor de las palabras clave y los signos de puntuación, y la posición de las llaves .

Existen herramientas para automatizar el formateo de código. Se las conoce como formateadores, correctores de formato o indentadores de código . Estas herramientas convierten el código fuente de un estilo de formato a otro. Su implementación es relativamente sencilla, ya que la sintaxis de los lenguajes de programación es inequívoca. La herramienta lee el código fuente, reconoce sus estructuras componentes (como sentencias de asignación, condicionales y bucles ; véase el flujo de control ) y, a continuación, muestra el código fuente formateado según el estilo especificado en un archivo de configuración.

Algunos formateadores de código son aplicaciones independientes. Otros están integrados en editores de texto y entornos de desarrollo integrados . Por ejemplo, el editor Emacs tiene ajustes para especificar un lenguaje de programación ("Modo de lenguaje Emacs") y para indentar bloques de código en consecuencia. ^{[ 4 ]}

int foo ( int k ){ if ( k < 1 || k > 2 ){ printf ( "fuera de rango \n " ); printf ( "esta función requiere un valor de 1 o 2 \n " );} else { printf ( "cambiando \n " ); switch ( k ){ case 1 : printf ( "1 \n " ); break ; case 2 : printf ( "2 \n " ); break ;}}}

int foo ( int k ) { if ( k < 1 || k > 2 ) { printf ( "Fuera de rango \n " ); printf ( "Esta función requiere un valor de 1 o 2 \n " ); } else { printf ( "Cambiando \n " ); switch ( k ) { case 1 : printf ( "1 \n " ); break ; case 2 : printf ( "2 \n " ); break ; } } }

int foo ( int k ) { if ( k < 1 || k > 2 ) { printf ( "Fuera de rango \n " ); printf ( "Esta función requiere un valor de 1 o 2 \n " ); } else { printf ( "Cambiando \n " ); switch ( k ) { case 1 : printf ( "1 \n " ); break ; case 2 : printf ( "2 \n " ); break ; } } }

Conceptos relacionados

• La función Elastic Tabstop , presente en muchos editores de código fuente, detecta y mantiene las sangrías alineadas.
• La minificación , que hace que el código fuente sea compacto, aunque resulte más difícil de entender para los humanos.
• Ofuscación , hacer que el código fuente sea deliberadamente muy difícil de entender para los humanos, especialmente a medida que se vuelve más complejo.

Servicios públicos

• enscript , un convertidor de texto a PostScript, con funciones de formato legible.

• Algoritmo 268: Editor del lenguaje de referencia ALGOL 60 William M. McKeeman : Commun. ACM 8(11): 667-668 (1965)
• lgrind , Red integral de archivos TEX
• NEATER2: un reformateador de declaraciones fuente PL/I Kenneth Conrow, Ronald G. Smith : Commun. ACM 13(11): 669-675 (1970)
• SOAP - Simplificar programas Algol oscuros R. S. Scowen, D. Allin, AL Hillman, M. Shimell : Informe de la Unidad Central de Computación del Laboratorio Nacional de Física CCU6 (abril de 1969) Incluye listado formateado del código fuente SOAP.
  • SOAP - Un programa que documenta y edita programas ALGOL 60. RS Scowen, D. Allin, AL Hillman, M. Shimell : Comput. J. 14(2): 133-135 (1971)
  • Código fuente SOAP original del KDF9
• Guía del usuario de SOAP. (para Edinburgh IMP ) Peter Salkeld Robertson (1976)
  • Código fuente SOAP en/para IMP9
• Soap80: Un programa para formatear programas fuente IMP80. JM Murison, Centro Regional de Computación de Edimburgo (1980)
  • Código fuente SOAP en/para IMP80 E. N. Gregory, Universidad de Kent en Canterbury; Peter D. Stephens, Centro Regional de Computación de Edimburgo
• PRETTYP.PAS Impresor de formato Pascal antiguo. Ledgard et al.
• Pascal con estilo (1979)
• estilo(9) Directrices de estilo de FreeBSD
• vgrind , El proyecto Heirloom [Unix]
• Formato del código fuente según las directrices de estilo GNU