Escribo un informe y debo pensar en el lector. El informe tiene algo de código y algunas ilustraciones. Me pregunto cómo mostrar el código de forma legible. Ahora mezclo las fuentes Times New Roman 12 para texto normal con Courier 11 para el código. Pero podría escribir el código en LTL, lógica temporal lineal, que creo que se ve mejor pero no es realmente necesario y lleva mucho tiempo.
¿Crees que sería bueno mantener Times New Roman 12 para el texto normal y courier 11 para el código?
A menos que su institución tenga una guía de estilo específica para escribir y dar formato al código (que, por la existencia de esta pregunta, supongo que no la tiene), hablando como alguien que escribe documentación técnica para el software:
La fuente que generalmente uso es Cambria o la familia de fuentes Serif, tamaño 11, 0,5 espacios para el texto. Sin embargo, se me ha indicado específicamente que use estas fuentes.
Para el código, use una fuente en la que exactamente cada carácter ocupe la misma cantidad de espacio que cualquier otro carácter. Source Code Pro es un buen ejemplo de este tipo de fuentes.
El código debe sobresalir o ser fácilmente distinguible, así que guárdelo en un cuadro. Sobre todo (como se mencionó anteriormente), el formato del código debe ser como el que se encuentra en un IDE o editor de texto, de modo que cada carácter ocupe la misma cantidad de espacio. Por ejemplo,
Este es un programa que imprime "Hello World!" a la consola
String s = "¡Hola mundo!"; System.out.println(s);
Por lo general, he dudado en incluir comentarios en los bloques de código, especialmente si su documento ya explica lo que hace el código.
Otra cosa que sin duda podría hacer es simplemente tomar capturas de pantalla del código de su IDE/editor de texto, recortarlo en un programa de edición de imágenes y simplemente pegar la imagen resultante en su editor de documentos. Esto puede ser bueno, ya que generalmente los IDE tienen cosas como números de línea que de otro modo no estarían disponibles en texto preformateado.
Desafortunadamente, no puedo ofrecer muchos más consejos, ya que cuando se trata de preguntas sobre redacción técnica, la respuesta es "depende". Las diferentes instituciones tienen diferentes necesidades y, para ser honesto, si no le han dado una idea decente de cómo quieren que se formatee algo, es porque están actuando de manera poco profesional o no están demasiado preocupados por los detalles, siempre y cuando el mensaje llegue. .
Mónica Celio