本ブログ「Linuxとは日記」は移転しました
移転先の「Emacs設定ファイルのコメント記述方法」はこちら

2010年09月04日

Emacs設定ファイルのコメント記述方法

Emacsは近年のテキストエディタと違って、直接設定を編集することができます。編集することができるというよりも、直接記述する方がスタンダードでそれ以外の手段で設定を行うスタイルの方が特殊なのかもしれません。

設定ファイルはhomeフォルダの.emacs(dotemacs)、もしくは.emacs.elが自動で読み込まれます。

最初のうちは、WEBページや書籍に記載されている設定内容をコピペするだけだと思いますが、この作業を長期間行なっていると、次第に.emacsの行数は膨れあがり、何を記述したのかも忘れてしまう状態になりがちです。

そうならないために、.emacsにはしっかりとコメントを記述しておくことが大切です。ある程度elisp(emacs lisp)を読み書きできるようになると、コメントを書かなくてもソースを読めば何をしているかわかるようになりますが、初心者のコピペで膨れあがった.emacsはコメント無しで暗号文に感じてしまうはずです。

elispのコメントは「;」という記号文字を利用します。;が記入されるとその行は;から行末までコメントと判断され、その部分は評価されなくなります。

; から行末までということは;;;と記述しても、一つ目の;から行末までコメントとみなされるのです。この特性を活かして、elispのコーディング規約では、コメントの内容の種類によって;の表現方法を変化させます。

例えば、;一つはその行の内容を説明するために。二つは次の行に対するコメントです。三つは、次の関数やまとまりを説明するためのコメントとして利用されます。

;; スクロールバーの設定
(set-scroll-bar-mode 'right) ;nilで非表示
;;; ELScreen
(require 'elscreen)
(load "elscreen" "ELScreen" t)

基本的には上記のような記述方法ですが、.emacsは設定ファイルなので、厳密な記述方法に乗っ取る必要はなく、自分がわかりやすいようにすれば良いのです。よく使われるテクニックとしては、カテゴリ毎に分ける方法があります。

;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
;;; 表示設定 
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;

このように、表示に関する設定や、動作設定、プラグインの設定などカテゴリ毎にに分けて管理しやすいようにするのも一つのテクニックです。

今回はコメントの記述方法で、設定ファイルを読みやすくするというテクニックをご紹介しましたが、設定ファイルをジャンルや機能毎に分割して、.emacsからそれらを読み込むというテクニックなどもありますので、自分に合った方法をいろいろと考えてみるのも良いかもしれません。

タグ:elisp Emacs
posted by Linuxとは at 17:30 | Emacs | このブログの読者になる | 更新情報をチェックする
×

この広告は1年以上新しい記事の投稿がないブログに表示されております。