Next: , Up: 10


10.1 定義コマンドテンプレート

Texinfo では定義するものをカテゴリで分類します。定義コマンドにはカテゴリが定められたある特定の種類のものを定義するコマンドと、カテゴリから指定するコマンドがあります。

定義コマンドは単独行に記述します。@defun コマンド1 はカテゴリ `Function' の関数を定義するコマンドで、以下のように記述します。

     @defun function arguments
     body-of-definition
     @end defun

function に定義する関数、arguments にその関数がとる引数、body-of-definition に関数定義を記述します。arguments は複数指定可能で、引数をとらなければ何も記述せず省略することが可能です。

     @deffn category function arguments
     body-of-definition
     @end deffn

上記の @deffn コマンド2 も関数を定義するコマンドですが、カテゴリは定められていません。このコマンドではカテゴリが category で指定したものとなります。

各コマンド 1 行目の category, function, arguments 等の引数は、定義ヘッダとしてそれぞれ引数の種類により等幅フォントや斜体で出力されます3。引数はスペースで区切られるので、各引数に半角スペースが含まれるときは波括弧 `{ 〜 }' で囲わなければなりません。


Footnotes

[1] See Function.

[2] See 関数.

[3] See 定義コマンドの出力例.