Previous: Man Page, Up: Documentation [Contents][Index]
Emacs Lispコードを編集するとき、コマンドC-h f (describe-function)およびC-h
v (describe-variable)で、使用したい関数または変数のビルトインドキュメントを閲覧できます。Name Helpを参照してください。
ElDocモードは、Lispドキュメントを検索するのに助けとなる、バッファーローカルなマイナーモードです。これが有効な場合、ポイントがLisp関数または変数にあるときは、有用な情報がエコーエリアに表示されます。関数の場合は引数リスト、変数の場合は変数のドキュメントストリングの最初の行が表示されます。ElDocモードに切り替えるには、M-x eldoc-modeとタイプします。Global ElDocモード(デフォルトでオン)もあり、これは下記の変数をセットするメジャーモードがに作用します。グローバルにオフにするにはM-x global-eldoc-modeとタイプしてください。
以下の変数はElDocモードをカスタマイズするのに使用されます:
eldoc-documentation-strategyこの変数はポイント位置のアイテムにたいするドキュメントを、フックeldoc-documentation-functionsから取得するために使用する関数を保持します。デフォルトではeldoc-documentation-strategyはeldoc-documentation-functionsフックにより生成された最初のドキュメント文字列をリターンしますが、これらの関数の結果を別の方法で構成するようにカスタマイズできます。
eldoc-documentation-functionsこのアブノーマルフックはドキュメンテーション関数を保持します。 This abnormal hook holds documentation functions. これはElDocにたいするバックエンドのコレクションとして動作します。これはモードがElDocに自身のドキュメンテーション関数を登録するために使用するべきものです。
eldoc-display-truncation-message非nil
(デフォルト)なら、(エコーエリアで切り詰められていれば)完全なドキュメントの閲覧方法について詳細なメッセージを表示します。nilなら切り詰められたメッセージは単に‘...’とマークされます。