La respuesta, por supuesto, puede depender de muchos factores, pero si comenzamos con un código de texto plano correcto y bien formateado , entonces uno puede generalizar más o menos las cosas aquí.
El 'formato' inicial en el texto fuente será:
nueva línea , espacio y caracteres de tabulación . Tenga en cuenta que la nueva línea y el salto de línea manual (como en el software DTP) no son lo mismo, y viceversa, algunos idiomas raros pueden
permitir otros caracteres de formato, aunque nunca he oído hablar de ellos.
Los comentarios no son parte ejecutable del código, por lo que pueden formatearse sin mucho riesgo, si se sabe si realmente es un comentario. Entonces, lo primero que debe observar es cómo se etiquetan los comentarios.
Es bueno conocer algunos conceptos básicos sobre el formato de texto sin formato inicial. Por ejemplo, para Python, existe la guía de estilo PEP8 . Si bien está hecho para Python, esta guía de formato se puede utilizar como referencia para los principales lenguajes como C / C ++ y Java. Examinar varios proyectos de ejemplo puede ayudar en caso de duda.
Por lo tanto, el primer principio sería: No cambie el texto fuente.
Revisaría una lista de verificación, asegúrese de que:
- No se produce el reemplazo automático de caracteres en ninguna etapa.
- No se realizan modificaciones en el texto (a menos que esté 100% seguro de que se deben hacer).
- No aparecen líneas ajustadas.
- Las sangrías se conservan visualmente y son consistentes (aproximadamente cuatro x anchuras por nivel de sangría).
- El nivel de sangría inicial (cero) debe ser visible.
- Los estilos definidos no destruyen el formato de la sintaxis (si se utiliza el resaltado de sintaxis).
- Tenga una copia de seguridad de la fuente en texto plano, para poder volver a verificar el formato original o comenzar de nuevo.
- Los números de línea, si están presentes, deben estar intactos, especialmente si se mencionan en las explicaciones.
En realidad, si la fuente original está formateada correctamente, no debería haber ningún ajuste de línea. Si las líneas ajustadas siguen apareciendo y son inevitables, entonces una sangría colgante de un nivel es la solución más común (ver PEP vinculada anteriormente). Si es necesario romper la línea, mejor consulte la guía de estilo o al autor.
Todavía algunos caracteres menores de 'espacio en blanco' pueden requerir reemplazo. Dado que la fuente puede incluir caracteres de tabulación, esto significa, por supuesto, que la fuente debe asegurarse de que todas las tabulaciones al comienzo de cada línea sean consistentes, es decir, las sangrías anidadas se conservan visualmente y cada siguiente nivel de sangría es del mismo ancho (ca. cuatro x anchos por un nivel de sangría).
Idealmente, las hendiduras que se hicieron con caracteres de espacio o espacios mixtos y pestañas deben reemplazarse con tabulación (o con lo que el software DTP puede hacer mejor para las sangrías anidadas), por lo que, si es necesario, ajustar las sangrías puede ser más fácil.
Por supuesto, uno puede dejar espacios, pero puede ser más difícil administrar su ancho al cambiar la fuente y más difícil alinear las hendiduras de la línea interna como en las columnas de la tabla.
Fuente monoespaciada + espacios
Tenga en cuenta que si la fuente está formateada con espacios intencionalmente y estaba destinada a leerse solo en fuentes monoespaciadas (por ejemplo, diagramas ASCII o arte ASCII), uno debe preservar los espacios sin cambios , pero esta decisión debe tomarse desde el principio. La fuente "Courier New" es más común en este caso. Sin embargo, si no es realmente necesario, desaconsejo el monoespacio, porque cada vez menos personas eligen el monoespaciado para la codificación hoy en día, y en caso de revisión, las fuentes proporcionales brindarán una mejor experiencia de lectura.
En general, las fuentes condensadas (por ejemplo, Arial estrechas) o más pequeñas pueden funcionar mejor: da más énfasis en contraste con el texto del cuerpo, hará que el código sea más compacto y, por lo tanto, sea menos probable que aparezca un ajuste de línea no deseado.
Creo que aquí se puede dibujar una línea, y si se hace lo anterior, entonces hay un 99% de probabilidad de que todo esté bien, al menos para un bloque de código de fuente simple sin colores.
Herramientas y formateo avanzado
Además, el aspecto se puede mejorar significativamente mediante el resaltado de sintaxis.
impresión en color o visualización en pantalla: en un diseño a todo color se pueden usar todas las funciones de resaltado, por lo que es el mejor de los casos, pero la impresión puede dar algunos cambios de color.
escala de grises o impresión en blanco y negro: aquí, por supuesto, uno puede usar negrita (por ejemplo, palabras clave) o cursiva (por ejemplo, comentarios), pero tenga en cuenta que los colores se convertirán a gris con todas las consecuencias. Por ejemplo, los comentarios en gris pueden verse bien en una pantalla, pero pueden volverse demasiado pálidos en el papel.
La pregunta más importante es si el creador de diseño tiene herramientas que puedan representar el código de forma legible. Afortunadamente, hay muchas herramientas gratuitas para la edición de código, las más destacadas (para Windows) son: Notepad ++, VSCode, Visual Studio . Pero tenga en cuenta las posibles autoconversiones implícitas de pestañas a espacios.
En Notepad ++ hay una opción para exportar el código como RTF , que preservará todo el formato y el resaltado de sintaxis de la fuente.
Si el diseño no requiere un cambio en el flujo de texto en la presentación del código, uno puede usar directamente imágenes (capturas de pantalla): no es tan flexible como el texto, pero conservará el formato al 100% y la numeración de líneas, y puede ahorrar mucho tiempo. Por ejemplo, los números de línea pueden ser difíciles de preservar en forma de texto. También exportar a PDF es una buena alternativa, pero no todo el software DTP puede incrustar archivos PDF y se puede perder algo de formato al imprimir en PDF.
Por ejemplo, mi configuración para el código Python en Notepad ++ se ve así:
Esto es solo para ilustrar, que uno puede usar capturas de pantalla directamente y que en realidad puede ser el método más fácil. Hay varias herramientas que pueden ayudar con la captura de pantalla: una puede necesitar "coser" las pantallas para obtener imágenes de mayor resolución.
El esquema de color es, por supuesto, individual, definido en el configurador de estilo del editor, que ya conoce el lenguaje admitido, lo que dificulta el formateo falso incluso si uno no conoce la sintaxis. Aquí las reglas generales de tipografía deberían funcionar: no demasiados colores, fuentes consistentes, hendiduras, espacios de líneas cómodos.
También son comunes herramientas / complementos adicionales para definiciones de lenguaje personalizadas, pero requieren conocimiento de sintaxis.