現在、正式な調査レポートを作成しており、このレポートにコードを含める予定です。
質問:調査レポートにコードを表示する方法として認められているものはありますか? フォント、スペースなどの点と、コードをドキュメント内に表示するか、付録に表示するかの両方について考えています。
コードは JavaScript と PHP になります。コードのどのセクションも 25 行を超えることはありません (したがって、これらは単なるスニペットです)。約半ダースのスニペットがあります。各スニペットには、コードで何が起こっているかを説明するいくつかの段落と、その長所/短所に関する議論があります。
私は報告書の提出先の組織と連絡を取り合っておらず、コードのフォーマット方法に関するガイドラインも公開していません (これらの点について質問しないでください)。
まあ、それはあなたの論文がどのスタイルガイドに準拠するように書かれているかによって異なります...
通常、コードは読みやすいようにモノタイプ フォントで記述します (Lucida Sans Console や Courier New など)。これは、すべての文字がページ上で同じスペースを占めることを意味します。
公開用のビットを書いたとき、コードを横から 2.5cm インデントし、Lucida Sans Console フォントで明るい灰色の背景を与えました... C スタイルのコードのインデントに従います。
あなたの教育機関にスタイル ガイドがあるかどうかお尋ねしますが、この能力がない場合は、ハーバード システムなどの一般的なスタイル ガイドを使用し、一貫して同じ形式に従うようにしてください。
スタイルを表示する Google Scholarのジャーナルのリストは次のとおりです。
これは私の好みです：
インラインで記述する場合は、説明に関係のないコード (前述の import ステートメントなど) を削除しますが、「明らかな」変数宣言なども含まれる可能性があります。コードをインラインに配置する目的は、そのコード ブロックを説明する段落と簡単に相互参照できるようにすることです。
付録に配置されたコードは完全である必要があります (これをコンパイラに挿入して [go] を押すことができます)。
完全なコードを含む付録への参照とともに、大幅に削減されたコードをスニペットに配置することを恐れないでください。付録コードは、誰かが個別に読み取り/実行するためのものです。インライン コードは、人々がそのセクションの特定のポイントを一目で理解できるようにするためのものです。
標準的なテキスト間隔と標準的な行間隔、すべて黒のテキスト、適切なインデントを備えた Courier フォントと言えます。
コード自体に関しては、インポートステートメントを省略し、コメントは問題ありません。{1}、{2} などの脚注をコメントとしてコードにインラインで追加し、コードを説明するテキストの下に参照を追加することもできます。
この論文の 6 ページに例があります。
http://www.eecs.berkeley.edu/Pubs/TechRpts/2006/EECS-2006-1.pdf
これは古い質問だと思いますが、コードの行に番号を付けることを忘れないでください! ワンライナーの場合、数字を飛ばしてもかまいませんが、それより大きいものはほとんど必須です。
JDとベンが言ったこと。
確立された適切な構文強調表示を使用する必要があります。vy32 が言及したLatex のリストパッケージには、Javascript と PHP の両方の構文強調表示スタイルがあり、特に Latex、HTML、および RTF に出力するPygmentsプログラムも同様です。
調査レポートを書く場合は、LaTeX を使用する必要があります。
私は通常、LaTeXvancyvrbパッケージとVerbatim.
ただし、別のオプションは、listingsパッケージを使用することです。コマンドを使用してファイルを直接入力できますlstinputlisting。行に自動的に番号を付け、スペース文字の代わりに _ 文字を使用しますが、これはプログラム可能です。それは本当にかなりいいです。