Previous: man-pageの照会, Up: ドキュメントの照会 [Contents][Index]
Emacs Lispコードを編集するとき、コマンドC-h f (describe-function)およびC-h
v (describe-variable)で、使用したい関数または変数のビルトインドキュメントを閲覧できます。コマンドと変数名のヘルプを参照してください。
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これはドキュメント用の関数を保持するアブノーマルフックであり、ElDoc用バックエンドのコレクションとして機能します。これはモードがElDocにドキュメント用の関数を登録するために使用します。
eldoc-echo-area-display-truncation-message非nil(デフォルト)であれば、完全なドキュメントを閲覧する方法に関する追加メッセージを表示します(エコーエリアでドキュメントが切り詰められていた場合)。nilなら、切り詰められているメッセージは単に‘...’でマークされます。