Come formattare il codice nei rapporti di ricerca

Question

Attualmente sto scrivendo un rapporto di ricerca formale e includerò il codice con questo rapporto.

Domanda: Esiste un modo accettato di visualizzare il codice nei rapporti di ricerca? Sto pensando sia in termini di carattere, spaziatura, eccetera, sia se il codice deve essere visualizzato all'interno del documento o in un'appendice.

Il codice sarà JavaScript e PHP. Nessuna delle sezioni di codice sarà più di 25 righe (quindi sono semplici frammenti). Ci saranno circa una mezza dozzina di frammenti. Ciascuno dei frammenti avrà un paio di paragrafi che spiegano cosa sta succedendo nel codice e una discussione sui suoi pro/contro.

Non ho alcun contatto con l'organismo a cui verrà inviato il report e non dispongono di linee guida pubblicate su come formattare il codice (si prega di non mettere in discussione questi punti).

Answer 1

Beh, dipende da quale guida di stile la carta è stata scritta per conformarsi a ...

solito codice dovrebbe essere scritto in un font monotipo in modo che sia facilmente leggibile (Eg Lucida Sans Console o Courier New) . Ciò significa che tutte le lettere occupano lo stesso spazio sulla pagina.

Quando ho scritto bit per l'editoria ho indentato il codice di 2.5 cm dal lato e gli ho dato uno sfondo grigio chiaro, in un font Lucida Sans Console ... Seguendo il codice stile C indentato.

Chiederei all'istituto se ha una guida di stile, ma poiché si ha una mancanza di questa capacità, si consiglia di seguire una guida di stile popolare come il sistema di Harvard e assicurarsi di seguire sempre lo stesso formato.

Ecco una lista di riviste da Google Scholar che mostrano lo stile: http://scholar.google.com.au/scholar?hl=en&q=PHP+SQL+programming+journal&btnG=Search&as_sdt=2000&as_ylo=&as_vis=0

Answer 2

direi carattere Courier con distanza standard di testo e la spaziatura linea standard, tutto il testo nero, corretta indentazione.

In termini di codice, omettere le istruzioni di importazione, i commenti sono a posto. Potresti voler aggiungere note a piedi come {1}, {2}, in linea nel codice come commento e riferimento sotto nel testo che spiega il codice.

Questa carta ha un esempio a pagina 6:

http://www.eecs.berkeley.edu/Pubs/TechRpts/2006/EECS-2006-1.pdf

Answer 3

Se si sta scrivendo un rapporto di ricerca, si dovrebbe utilizzare LaTeX.

In genere utilizzo il pacchetto LaTeX vancyvrb e lo Verbatim.

Tuttavia, un'altra opzione è utilizzare il pacchetto listings. Può inserire un file direttamente usando il comando lstinputlisting. Numera automaticamente le tue linee e usa il carattere _ invece del carattere spazio, ma questo è programmabile. È davvero carino

Answer 4

Questa è la mia preferenza:

Durante la scrittura in linea, sbarazzarsi di codice che è irrilevante per la spiegazione (come ad esempio l'importazione dichiarazioni come accennato in precedenza, ma le dichiarazioni potenzialmente anche di variabili che sono "evidenti" e simili).L'obiettivo del codice inserito in linea dovrebbe essere per un facile riferimento al paragrafo che descrive quel blocco di codice.

Il codice inserito nelle appendici dovrebbe essere completo (come in - è possibile inserire questo nel compilatore e premere vai).

Non aver paura di inserire codice fortemente ridotto in frammenti, insieme a un riferimento all'appendice contenente il codice completo - il codice dell'appendice è per qualcuno da leggere/eseguire separatamente. il codice inline è per le persone a dare un'occhiata e aiutare a capire il punto specifico di quella sezione.

Answer 5

Mi rendo conto che questa è una vecchia domanda, ma non dimenticare di numerare le righe nel codice! Per one-liner, va bene saltare i numeri, ma qualsiasi cosa più grande, sono quasi obbligatori.

Answer 6

Cosa hanno detto JD e Ben.

È necessario utilizzare l'evidenziazione della sintassi stabilita e appropriata. Il pacchetto listings di Latex, citato da vy32, ha gli stili di evidenziazione della sintassi per Javascript e PHP, così come il programma Pygments, che emette, tra gli altri, Latex, HTML e RTF.