Actualmente estoy produciendo una nueva edición de un viejo libro mío; este nuevo libro incorporará ejemplos de código de varios entornos informáticos diferentes.
Lo que quiero saber es: ¿cuál es la mejor manera de diferenciar los diferentes entornos en su documento? Por supuesto, puedo decirlo en el texto:
This is how it's done in foogle:
<foogle code example>
and this is how it's done in scronk:
<scronk code example>
La idea es que al echar un vistazo a la página debería ser inmediato ver qué ejemplo de código se relaciona con qué idioma.
¿Existe una "mejor práctica" para este tipo de cosas? La mayoría de los textos se concentran en un solo lenguaje de programación, por lo que esto rara vez es un problema.
Aquí hay un diseño posible, donde he puesto los dos ambientes diferentes en cajas con etiquetas adheridas (esto por eficiencia de espacio). Estoy usando TeX/LaTeX como mi motor de composición tipográfica, por lo que tengo un control muy fino sobre todos los aspectos del diseño.
(Tenga en cuenta que este es solo un ejemplo de cortar y pegar, por lo tanto, lo que parece ser el "Capítulo 1" comienza en medio de un ejemplo).
Aquí hay otra versión de lo mismo, tratando de tener en cuenta los comentarios de mayúsculas:
Los encabezados (fuente proporcional) y los bloques de código (fondo, fuente monoespaciada) son tipográficos, la solución más simple y limpia. Funcionará con fragmentos pequeños y ejemplos grandes (página desbordada):
Pitón
print "Hello world!"
JavaScript
alert('Hello world!');
sql
SET SERVEROUTPUT ON;
BEGIN
DBMS_OUTPUT.PUT_LINE('Hello, world!');
END;
Los encabezados pueden ocupar mucho espacio. Especialmente cuando tienes muchos fragmentos cortos. Comentar el nombre del idioma como etiqueta es una buena alternativa:
# Python
print "Hello world!"
// JavaScript
alert('Hello world!');
-- SQL
SET SERVEROUTPUT ON;
BEGIN
DBMS_OUTPUT.PUT_LINE('Hello, world!');
END;
Separe estos fragmentos con un pequeño espacio en blanco. Entonces su lector lo ve como tres bloques.
Un ejemplo de código en línea:
Ahora escribe print 'Hello World!'
. ¡Bien hecho!
De nuevo monoespaciado y fondo gris. Una fuente monoespaciada para el código es una opción obvia. Pero existen otros métodos para crear 'contraste' entre el cuerpo del texto y el código. Los métodos tipográficos obvios para hacer distinciones son tipo de letra, tamaño, color, posición, forma, etc.
Para hacer una distinción entre los dos lenguajes de programación, puede elegir de la misma paleta.
Estos son algunos comentarios sobre su maqueta:
.m
Matlab, .py
Phyton. Explícalos en un capítulo de convenciones tipográficas. http://books.google.nl/books?id=nEJ-jcYF2fMC&lpg=PP1&hl=nl&pg=PR41#v=onepage&q&f=falseEjemplo sin fondo y con sangría:
Creo que un pequeño ícono antes de los ejemplos de código (en el margen, también conocido como 'fuera del lienzo'). Será agradable.
Guarde copias de sus ciclos de diseño para poder comparar y ver qué funciona mejor. Normalmente hago pasos muy pequeños, ahorrándome todo el proceso.
Mis comentarios son solo consejos, tienes que ver por ti mismo qué funciona mejor.
>>>
a py>
/ mt>
. Sin embargo, podría estar demasiado ocupado.
Ryan
Vicente
Tomás Weller
DA01
Horacio
cimarrón
Alasdair McAndrew