Programación alfabetizada

Según Knuth, ^{[ 8 ] [ 9 ]} la programación literaria proporciona programas de mayor calidad, ya que obliga a los programadores a expresar explícitamente las ideas que subyacen al programa, haciendo más evidentes las decisiones de diseño mal concebidas. Knuth también afirma que la programación literaria proporciona un sistema de documentación de primera categoría, que no es un añadido, sino que se desarrolla de forma natural durante el proceso de exposición de las ideas durante la creación de un programa. ^{[ 10 ]} La documentación resultante permite al autor retomar sus propios procesos de pensamiento en cualquier momento posterior y facilita a otros programadores la comprensión de la estructura del programa. Esto difiere de la documentación tradicional, en la que al programador se le presenta el código fuente siguiendo un orden impuesto por el compilador y debe descifrar el proceso de pensamiento que subyace al programa a partir del código y sus comentarios asociados. También se afirma que las capacidades de metalenguaje de la programación literaria facilitan el pensamiento, proporcionando una visión más general del código y aumentando el número de conceptos que la mente puede retener y procesar con éxito. La aplicabilidad del concepto a la programación a gran escala, la de programas de grado comercial, se demuestra mediante una edición de código TeX como un programa legible. ^{[ 8 ]}

Knuth también afirma que la programación literaria puede conducir a una fácil portabilidad del software a múltiples entornos, e incluso cita la implementación de TeX como ejemplo. ^{[ 11 ]}

La programación literaria se malinterpreta con frecuencia ^{[ 12 ]} como referida únicamente a la documentación formateada producida a partir de un archivo común con código fuente y comentarios —lo que propiamente se denomina generación de documentación— o a los extensos comentarios incluidos con el código. Esto es lo contrario de la programación literaria: el código bien documentado o la documentación extraída del código sigue la estructura del código, con la documentación integrada en él; mientras que en la programación literaria, el código está integrado en la documentación, y el código sigue la estructura de la documentación.

Esta idea errónea ha llevado a afirmar que las herramientas de extracción de comentarios, como los sistemas Perl Plain Old Documentation o Java Javadoc , son "herramientas de programación literaria". Sin embargo, dado que estas herramientas no implementan la "red de conceptos abstractos" que se esconde tras el sistema de macros de lenguaje natural, ni proporcionan la capacidad de cambiar el orden del código fuente de una secuencia impuesta por la máquina a una que resulte conveniente para la mente humana, no pueden considerarse propiamente herramientas de programación literaria en el sentido que les da Knuth. ^{[ 12 ] [ 13 ]}

El siguiente fragmento del wcprograma literario ^{[ 14 ]} muestra cómo se utilizan frases descriptivas arbitrarias en un lenguaje natural en un programa literario para crear macros, que actúan como nuevos "operadores" en el lenguaje de programación literario y ocultan bloques de código u otras macros. La notación de marcado consiste en corchetes angulares dobles ( ) que indican macros. El símbolo que, en un archivo noweb, indica el comienzo de un bloque de documentación. El símbolo representa la "raíz", el nodo superior desde el que la herramienta de programación literaria comenzará a expandir la red de macros. De hecho, la escritura del código fuente expandido se puede hacer desde cualquier sección o subsección (es decir, un fragmento de código designado como , con el signo igual), por lo que un archivo de programa literario puede contener varios archivos con código fuente de máquina.<<...>>@<<*>><<name of the chunk>>=

El propósito de wc es contar líneas , palabras y / o caracteres en una lista de archivos . El número de líneas en un archivo es ........ / más explicaciones /​​Aquí , entonces , hay una descripción general del archivo wc.c que es definido por el programa noweb wc.nw : << * >> = << Archivos de cabecera a incluir >> << Definiciones >> << Variables globales >> << Funciones >> << El programa principal >> @Debemos incluir las definiciones de E / S estándar , ya que queremos enviar la salida formateada a stdout y stderr . << Archivos de cabecera a incluir >>= #include <stdio.h> @

El desenlace de los fragmentos puede realizarse en cualquier parte del archivo de texto del programa, no necesariamente en el orden en que aparecen en el fragmento que los contiene, sino según lo exija la lógica reflejada en el texto explicativo que engloba todo el programa.

Las macros no son lo mismo que los "nombres de sección" en la documentación estándar. Las macros de programación literaria ocultan el código real y se pueden usar dentro de cualquier operador de lenguaje máquina de bajo nivel, a menudo dentro de operadores lógicos como if, whileo case. Esto se puede ver en el siguiente wcprograma literario. ^{[ 14 ]}

El fragmento actual , que realiza el conteo , fue en realidad uno de los más sencillos de escribir . Analizamos cada carácter y cambiamos de estado si comienza o termina una palabra .<< Escanear archivo >>= while ( 1 ) { << Llenar el búfer si está vacío ; salir al final del archivo >> c = * ptr ++ ; if ( c > ' ' && c < 0177 ) { /* códigos ASCII visibles */ if ( ! in_word ) { word_count ++ ; in_word = 1 ; } continue ; } if ( c == ' \n' ) line_count ++ ; else if ( c != ' ' && c != '\t' ) continue ; in_word = 0 ; /* c es nueva línea, espacio o tabulación */ } @

Las macros representan cualquier fragmento de código u otras macros, y son más generales que la segmentación de arriba hacia abajo o de abajo hacia arriba, o que la subsección. Donald Knuth dijo que cuando se dio cuenta de esto, comenzó a pensar en un programa como una red de varias partes. ^{[ 1 ]}

En un programa sin alfabetización web, además del orden libre de su exposición, los fragmentos detrás de las macros, una vez introducidos con , pueden ampliarse posteriormente en cualquier lugar del archivo simplemente escribiendo y añadiendo más contenido, como ilustra el siguiente fragmento ( es añadido por el formateador de documentos para facilitar la lectura y no está en el código). ^{[ 14 ]}<<...>>=<<name of the chunk>>=+

Los totales generales deben inicializarse a cero al comienzo del programa. Si hiciéramos que estas variables fueran locales a main, tendríamos que hacer esta inicialización. explícitamente; sin embargo, las variables globales de C se inicializan automáticamente a cero. (O mejor dicho, ``estáticamente puesto a cero.' ⁠ ' (¿Lo entiendes?) < < Variables globales > > += longtot_word_count,tot_line_count, recuento_total_de_caracteres; /* total number of words, lines, chars */ @

La documentación de un programa escrito se genera como parte del proceso de escritura del programa. En lugar de comentarios como notas al margen del código fuente, un programa escrito contiene la explicación de conceptos en cada nivel, con los conceptos de nivel inferior ubicados en el lugar correspondiente, lo que facilita una mejor comunicación del pensamiento. Los fragmentos de código escritos wcanteriores muestran cómo se entrelazan la explicación del programa y su código fuente. Esta exposición de ideas crea un flujo de pensamiento similar al de una obra literaria. Knuth escribió una «novela» que explica el código del juego de ficción interactiva Colossal Cave Adventure . ^{[ 15 ]}

• TeX y METAFONT , los lenguajes de composición tipográfica y descripción de fuentes de Knuth, respectivamente. Escritos en WEB , fueron pruebas de concepto de la programación literaria.
• El libro " Renderizado basado en la física " ^{[ 16 ]} describe tanto la teoría matemática que sustenta un sistema moderno de renderizado fotorrealista como su implementación práctica. Este libro ganó un premio Óscar.
• Comprender MP3, ^{[ 17 ]} una implementación completa de flujos de bits MPEG que también es un excelente tutorial. (Véase también los programas literarios de Ruckert relacionados con HINT. ^{[ 18 ]} )
• Principia Softwarica, ^{[ 19 ]} una versión legible del Plan 9 de Bell Labs .
• La Stanford GraphBase, ^{[ 20 ]} 30 ensayos cortos de CWEB de Knuth que definen una plataforma de computación combinatoria, describen algoritmos y estructuras de datos de última generación y proporcionan ejemplos de su uso.
• MMIXware, ^{[ 21 ]} Software de Knuth para admitir la programación MMIX y ejecutar simulaciones en diferentes arquitecturas.
• Interfaces e implementaciones de C, ^{[ 22 ]} una demostración de la metodología de diseño titular en 24 ejemplos.
• Un compilador C reorientable, ^{[ 23 ]} describe el pequeño compilador C LCC .
• Estructuras de datos y algoritmos en C++: Introducción de bolsillo, ^{[ 24 ]} un recorrido pedagógico conciso.
• Inform , un lenguaje y sistema para escribir ficción interactiva. Uno de los programas más grandes hasta la fecha, Inform está escrito en inweb ^{[ 25 ]} (un ejemplo notable en sí mismo).
• Axiom , que evolucionó a partir de Scratchpad, un sistema de álgebra computacional desarrollado por IBM, está siendo desarrollado actualmente por Tim Daly, uno de los desarrolladores de Scratchpad. Axiom está escrito completamente como un programa literario. ^{[ 26 ] [ 27 ]}