このセクションは関数やそれに類似した構成要素の記述のためのコマンドを記述 します.
@deffn
category name arguments...
@deffn
コマンドは,関数,対話式コマンド,そして引数を取る類似の構
成要素のための一般的な定義コマンドです.定義されている構成要素のカテゴリ
を記述する用語を選択する必要があります.例えば,“関数”は,構成要素が関
数の場合使用されます.@deffn
コマンドは,行の最初に,同じ行に記述
する構成要素のカテゴリ,この特定の構成要素の名前,そして,存在する場合そ
の引数を続けます.単独行の@end deffn
で定義を終了してください.
例えば,定義を以下のようにします.
@deffn Command forward-char nchars ポイントを@var{nchars}文字前に移動します. @end deffn
これは,一つの引数ncharsを持つforward-char
という名前の“コマ
ンド”の,どちらかというと簡潔な定義を表示します.
@deffn
は,ncharsのような引数名を@var
が使用されてい
るかのようにイタリックまたは大文字で印刷し,それは,これらの名前がメタ構
文変数と考えるためです — それは実際の引数の値を意味します.記述のテキ
ストで引数の値を述べるため,明示的に@var
で引数名を書いてください.
上記の例では,このように‘@var{nchars}’を使用しています.
@deffn
のテンプレートは以下のとおりです.
@deffn category name arguments... body-of-definition @end deffn
@defun
name arguments...
@defun
コマンドは関数に対する定義コマンドです.@defun
は,
‘@deffn Function ...’と同じです.
例えば,以下のようにします.
@defun set symbol new-value シンボル@var{symbol}の値を@var{new-value}に変更します. @end defun
これは,引数がsymbolとnew-valueの関数set
の,どちらか
というと簡潔な定義を表示します.@defun
行の引数名は,@var
で囲まれているかのように自動的にイタリックまたは大文字で現れます.単独行
の@end defun
で定義を終了してください.
テンプレートは以下のとおりです.
@defun function-name arguments... body-of-definition @end defun
@defun
は関数索引に項目を生成します.
@defmac
name arguments...
@defmac
コマンドはマクロの定義コマンドです.@defmac
は
‘@deffn Macro ...’と同じで,@defun
のように動作します.
@defspec
name arguments...
@defspec
コマンドは,スペシャルフォームの定義コマンドです.(Lisp
では,スペシャルフォームは関数によく似た構成要素です.see Special Forms.)@defspec
は
‘@deffn {Special Form} ...’と同じで,@defun
のように
動作します.