次: kbd, 前: Useful Highlighting, 上: Indicating
@code
{sample-code}
プログラムの一部と,全体が構文的なトークンからなるテキストを示すため,
@code
コマンドを使用してください.カッコでテキストを囲ってくださ
い.
このため,@code
をプログラム内部の式,プログラムで使用している変
数や関数の名前,またはプログラム言語のキーワードに対して使用すべきです.
Texinfoのようなプログラム言語に似ている言語のコマンド名に対して
@code
を使用してください.例えば,@code
と@samp
は,
Texinfoソースファイルで,それぞれ`@code{@@code}'と
`@code{@@samp}'と書くことで生成されます.
文の最初に現れるとき,@code
コマンドの中で単語の大文字小文字を変
えるのは正しくありません.ほとんどのコンピュータ言語は大文字小文字の違い
を識別します.例えばCでは,Printf
はprintf
の識別子と異なり,
それはおそらくスペルミスです.大文字小文字の区別をしない言語でも,異なる
方法で綴られた識別子を見ると人間の読者は混乱します.一つの綴りを選び,そ
れを常に使用してください.全てが小文字で書かれたコマンド名で文を開始した
くない場合,文の配置替えをするべきです.
印刷されたマニュアルでは,@code
でTeXは引数をタイプライターフェ
イスのフォントで植字します.Infoファイルでは.Info書式化コマンドはシング
ルクォーテーションマークでテキストの周りを囲みます.
例えば,以下のようにします.
The function returns @code{nil}.
印刷されたマニュアルで,これは以下を生成します.
The function returns nil
.
@code
を使用しないほうが好ましい状況は,以下のものです.
@command
を使用してください).
@option
を使用してくだ
さい).
@code
より@samp
を使用して書い
た方が良く見えます.この場合,規則はより喜ばしい書式を選択するためです.
@env
を使用してください).
goto-char
の名
前の一部の`goto-ch'に関して書く場合,@samp
を使用すべきです.
@code
を使用しないでください.(@samp
を使用してください.)また,入力が
プログラム言語のような言語で書かれていない場合,プログラムの入力と考えら
れるテキストに印を付けるために@code
を使用すべきではありません.
例えば,GNU Emacsのキーストロークコマンドに対して@code
を使用すべ
きではありませんが(代わりに@kbd
を使用してください),キーストロー
クコマンドが呼び出すEmacs Lispの関数名に対し@code
を使用してもか
まいません.
@command
,@option
,そして@env
は比較的最近導入さ
れたので,@code
や@samp
をコマンド名,オプション,そして環
境変数に使用することも可能です.新しいコマンドでより正確に印付けを表現で
きますが,より古いコマンドの使用でも実害は無く,もちろん長期存続のマニュ
アルはそうしています.