9.1.1 @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を使用しないほうが好ましい状況は，以下のものです．

• lsのようなシェルコマンド名(@commandを使用してください)．
• `-c'のようなシェルオプション単独のとき(@optionを使用してくだ さい)．
• また，シェルコマンド全体は，@codeより@sampを使用して書い た方が良く見えます．この場合，規則はより喜ばしい書式を選択するためです．
• TEXINPUTSのような環境変数(@envを使用してください)．
• 構文トークンより短い文字列．例えば，Emacs Lisp関数のgoto-charの名 前の一部の`goto-ch'に関して書く場合，@sampを使用すべきです．
• 一般的に，トークンで使用されている文字に関して書く場合です．例えば，関数 名で使用可能な文字や印刷可能なシンボルを説明しているとき，@code を使用しないでください．(@sampを使用してください．)また，入力が プログラム言語のような言語で書かれていない場合，プログラムの入力と考えら れるテキストに印を付けるために@codeを使用すべきではありません． 例えば，GNU Emacsのキーストロークコマンドに対して@codeを使用すべ きではありませんが(代わりに@kbdを使用してください)，キーストロー クコマンドが呼び出すEmacs Lispの関数名に対し@codeを使用してもか まいません．

@command，@option，そして@envは比較的最近導入さ れたので，@codeや@sampをコマンド名，オプション，そして環 境変数に使用することも可能です．新しいコマンドでより正確に印付けを表現で きますが，より古いコマンドの使用でも実害は無く，もちろん長期存続のマニュ アルはそうしています．