RubyにもJavaDocぽいものを出力するためのツールとして、YARDというものがあるらしい。
ハイライトをEmacsから行えないか調べた所、
yard-modeというのがあるらしいのでインストールしてみた。
事前に必要なもの
- git
- emacs
- ruby-mode
yard-modeをgithubからclone
yard-modeをgithubからcloneしてきます。
emacsの拡張は、submoduleにして.emacs.d配下に突っ込むようにしているので、
今回も同様にしてます。
1 | $ cd ~/.emacs.d |
clone後は、.emacs.d配下にyard-mode.elというディレクトリが作成され、yard-modeのソースコードがその中に入っています。
init.elにyard-modeの設定記述
次に、~/.emacs.d/init.elファイルにyard-modeの設定を追記します。
1 | (add-to-list 'load-path "~/.emacs.d/yard-mode.el") |
rubyファイルを開いた時に、yard-modeが有効になるように設定します。
1 | (add-hook 'ruby-mode-hook 'yard-mode) |
うまく設定されていれば、こんな感じでハイライトされます。

YARDのタグについては、こちらが参考になりそうです。