Actualmente estoy escribiendo un informe de investigación formal, y incluiré el código en este informe.Cómo dar formato al código en los informes de investigación
Pregunta: ¿Hay alguna forma aceptada de mostrar el código en los informes de investigación? Estoy pensando tanto en términos de fuente, espaciado, etcétera, y si el código debe mostrarse dentro del documento, o en un apéndice.
El código será JavaScript y PHP. Ninguna de las secciones de código tendrá más de 25 líneas (por lo que son simples fragmentos). Habrá aproximadamente media docena de fragmentos. Cada fragmento tendrá un par de párrafos explicando lo que está sucediendo en el código y una discusión sobre sus pros/contras.
No tengo contacto con el organismo al que se enviará el informe, y no tienen directrices publicadas sobre cómo formatear el código (no cuestione estos puntos).
Gracias por su respuesta, tomado en consideración. ¿Tiene alguna idea de si el código debe colocarse en línea con el texto o en un apéndice? – GlenCrawford
Siempre he coloqué en línea si es menos de una página, y en un apéndice si se trata de un largo trabajo duro de código .. Si es el tiempo que podría ser vale la pena analizar los números de línea, lo que puede cruzar la referencia código. Todos mis documentos universitarios que necesitaban código o matrices, etc., se citaron como Code 1.0 Code 1.1, etc. y estaban en línea. – Darbio
Hola, trabajo en una universidad, generalmente aquí (¡subjetivo!) Se agregan porciones importantes de código como apéndice, cualquier ejemplo de código agregado en línea en el informe. El código siempre debe seguir las convenciones de codificación dadas (¡también subjetivas!) –