Comment mettre en forme le code dans les rapports de recherche

Question

Je suis en train d'écrire un rapport de recherche officiel, et je vais inclure du code dans ce rapport.

Question: Existe-t-il un moyen accepté d'afficher le code dans les rapports de recherche? Je pense à la fois en termes de police, d'espacement, et cetera, et si le code doit être affiché à l'intérieur le document, ou dans une annexe.

Le code sera JavaScript et PHP. Aucune des sections du code ne comportera plus de 25 lignes (donc ce ne sont que des extraits). Il y aura environ une demi-douzaine d'extraits. Chacun des extraits comportera quelques paragraphes expliquant ce qui se passe dans le code, et une discussion sur ses avantages et ses inconvénients.

Je n'ai aucun contact avec le corps auquel le rapport sera soumis, et ils n'ont aucune directive publiée sur la façon de formater le code (ne remettez pas ces points en question).

Answer 1

Eh bien cela dépend de quel guide de style de votre papier est écrit pour se conformer à ...

Code général doit être écrit dans une police Monotype afin qu'il soit facilement lisible (par ex Lucida Console Sans ou Courier New) . Cela signifie que toutes les lettres occupent le même espace sur la page. Quand j'ai écrit des bits pour la publication, j'ai indenté le code à 2,5 cm du côté et lui ai donné un fond gris clair, dans une police Lucida Sans Console ... En suivant le retrait du code de style C. Je demanderais à votre institution s'ils ont un guide de style, mais comme vous n'avez pas cette capacité, utilisez un guide de style populaire tel que le système Harvard et assurez-vous de suivre le même format tout au long.

Voici une liste des journaux de Google Scholar dont le style d'affichage: 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

Je dirais que la police Courier avec un espacement de texte standard et l'espacement des lignes standard, tout le texte noir, une indentation correcte.

En termes de code lui-même, omettre les instructions d'importation, les commentaires sont corrects. Vous pouvez ajouter des notes de bas de page comme {1}, {2}, inline dans le code en tant que commentaire et référence ci-dessous dans le texte qui explique le code.

Ce document a un exemple à la page 6:

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

Answer 3

Si vous écrivez un rapport de recherche, vous devriez utiliser LaTeX. J'utilise généralement le paquet LaTeX vancyvrb et le Verbatim.

Toutefois, une autre option consiste à utiliser le package listings. Il peut entrer un fichier directement en utilisant la commande lstinputlisting. Il numérote automatiquement vos lignes et utilise le caractère _ au lieu du caractère espace, mais c'est programmable. C'est vraiment bien.

Answer 4

C'est ma préférence:

Lors de l'écriture en ligne, se débarrasser du code qui n'a rien à voir l'explication (telles que l'importation déclarations comme mentionné précédemment, mais les déclarations potentiellement variables aussi qui sont « évidentes », etc.).L'objectif du code placé en ligne devrait être une référence croisée facile avec le paragraphe décrivant ce bloc de code.

Le code placé dans les annexes doit être complet (comme dans - vous pouvez le mettre dans votre compilateur et appuyez sur OK). N'ayez pas peur de placer un code fortement réduit dans les extraits, avec une référence à l'annexe contenant le code complet - le code d'annexe est pour quelqu'un à lire/exécuter séparément. le code en ligne est pour les gens à regarder et à aider à comprendre le point spécifique de cette section.

Answer 5

Je me rends compte que c'est une vieille question, mais n'oubliez pas de numéroter les lignes dans votre code! Pour les one-liners, il est possible d'ignorer les numéros, mais pour les plus gros, ils sont presque nécessaires.

Answer 6

Ce que JD et Ben ont dit.

Vous devez utiliser la coloration syntaxique appropriée et établie. Le paquet listings de Latex, mentionné par vy32, a des styles de surlignement de syntaxe pour Javascript et PHP, tout comme le programme Pygments, qui produit, entre autres, Latex, HTML et RTF.