Wie man Code in Forschungsberichten formatiert

Question

Ich schreibe gerade einen formellen Forschungsbericht, und ich werde Code mit diesem Bericht einschließen.

Frage: Gibt es eine akzeptierte Möglichkeit, Code in Forschungsberichten anzuzeigen? Ich denke sowohl in Bezug auf Schriftart, Abstand, und so weiter, und ob der Code innerhalb das Dokument oder in einem Anhang angezeigt werden soll.

Der Code wird JavaScript und PHP sein. Keiner der Codeabschnitte wird mehr als 25 Zeilen umfassen (also nur Schnipsel). Es wird ungefähr ein halbes Dutzend Schnipsel geben. In jedem dieser Abschnitte werden einige Abschnitte erläutert, in denen erklärt wird, was im Code vor sich geht, und eine Diskussion über seine Vor- und Nachteile.

Ich habe keinen Kontakt mit der Stelle, an die der Bericht gesendet wird, und sie haben keine Richtlinien zur Formatierung von Code veröffentlicht (bitte stellen Sie diese Punkte nicht in Frage).

Answer 1

Nun, es hängt davon ab, welchen Style Guide Ihr Papier geschrieben wird, zu erfüllen ...

Normalerweise sollte Code in einer Monotypie Schrift geschrieben werden, so dass sie leicht lesbar (zB Lucida Sans-Konsole oder Courier New) ist . Dies bedeutet, dass alle Buchstaben den gleichen Platz auf der Seite einnehmen.

Wenn ich Bits für die Veröffentlichung geschrieben habe, habe ich den Code 2.5cm von der Seite eingerückt und ihm einen hellgrauen Hintergrund gegeben, in einer Lucida Sans Console Schriftart ... Nach C style code indenting.

Ich würde Ihre Institution fragen, ob sie einen Style Guide haben, aber da Sie diese Fähigkeit nicht haben, gehen Sie mit einem beliebten Style Guide wie dem Harvard System und achten Sie darauf, dass Sie das gleiche Format haben. Hier

ist eine Liste der Zeitschriften von Google Scholar, den Stil an: 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

Ich würde sagen, Courier-Schrift mit Standardtextabstand und Standard-Zeilenabstand, all schwarzen Text, richtigen Vertiefung.

In Bezug auf den Code selbst, Importanweisungen auslassen, Kommentare sind in Ordnung. Sie können Fußnoten wie {1}, {2}, Inline im Code als Kommentar und Referenz unten im Text hinzufügen, der den Code erläutert.

Dieses Papier hat ein Beispiel auf Seite 6:

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

Answer 3

Wenn Sie einen Forschungsbericht schreiben, sollten Sie LaTeX werden.

Ich verwende normalerweise das LaTeX vancyvrb-Paket und das Verbatim. Eine andere Option ist die Verwendung des listings Pakets. Es kann eine Datei direkt mit dem Befehl lstinputlisting eingeben. Es nummeriert automatisch Ihre Zeilen und verwendet das Zeichen _ anstelle des Leerzeichen, aber dies ist programmierbar. Es ist wirklich sehr nett.

Answer 4

Dies ist meine Präferenz:

Wenn Inline-Schreiben, loszuwerden Code, der auf die Erklärung (wie Import Aussagen wie bereits erwähnt, aber möglicherweise, die „offensichtlich“ auch Variablendeklarationen irrelevant ist und dergleichen).Das Ziel von inline plaziertem Code sollte eine einfache Querverweisung mit dem Abschnitt sein, der diesen Codeblock beschreibt.

Code in den Anhängen platziert sollte abgeschlossen sein (wie in - Sie können dies in Ihrem Compiler und drücken Sie auf Go).

Haben Sie keine Angst davor, stark reduzierten Code in Snippets zu platzieren, zusammen mit einem Verweis auf den Anhang mit dem vollständigen Code - der Anhang Code ist für jemanden separat zu lesen/zu laufen. Der Inline-Code ist für Personen gedacht, um den spezifischen Punkt dieses Abschnitts zu verstehen.

Answer 5

Ich weiß, dass dies eine alte Frage ist, aber vergessen Sie nicht, die Zeilen in Ihrem Code zu nummerieren! Für One-Liners ist es okay, Zahlen zu überspringen, aber alles Größere, sie sind fast erforderlich.

Answer 6

Was JD und Ben gesagt haben.

Sie sollten eine geeignete, etablierte Syntaxhervorhebung verwenden. Latex listings Paket, von vy32 erwähnt, hat Syntax-Highlighting-Stile für Javascript und PHP, ebenso wie das Pygments Programm, das unter anderem auf Latex, HTML und RTF ausgibt.