次: , 前: Functions Commands, 上: Def Cmds in Detail


15.4.2 変数とそれに類似した構成要素

変数とそれに類似した構成要素を定義するためのコマンドは以下のものです.

@defvr category name
@defvrコマンドは変数のようなものの一般的な定義コマンドです — 構成要素は値を記録します.定義された構成要素のカテゴリを記述するための, 用語を選択する必要があります.例えば,“変数”は構成要素が変数の場合使用 されます.@defvrコマンドを行の最初に書き,同じ行に構成要素のカテ ゴリと構成要素の名前を続けてください.

タイトルのようにカテゴリ名を大文字にしてください.カテゴリ名が“User Option”のようにスペースを含む場合,カッコで囲んでください.そうしない場 合,二番目の単語は構成要素の名前だと誤解されます.例えば,以下のようにし ます.

          @defvr {User Option} fill-column
          
          
          
          このバッファローカル変数は,
          補充された行の最大幅を指定します.
          ...
          @end defvr
     

単独行の@end defvrで定義を終了してください.

テンプレートは以下の通りです.

          @defvr category name
          body-of-definition
          @end defvr
     

@defvrnameに対し,変数索引の項目を作成します.


@defvar name
@defvarコマンドは,変数の定義コマンドです.@defvarは `@defvr Variable ...'と同じです.

例えば,以下のようにします.

          @defvar kill-ring
          ...
          @end defvar
     

テンプレートは以下の通りです.

          @defvar name
          body-of-definition
          @end defvar
     

@defvarは,nameに対し変数索引の項目を作成します.


@defopt name
@defoptコマンドは,ユーザオプション(user options),すなは ち,ユーザが好みで変更する変数に対する定義コマンドです.Emacsは多くのそ のようなものがあります(see Variables). @defoptは`@defvr {User Option} ...'と同じで, @defvarのように動作します.