Yard-modeを使ってみた

RubyにもJavaDocぽいものを出力するためのツールとして、YARDというものがあるらしい。
ハイライトをEmacsから行えないか調べた所、
yard-modeというのがあるらしいのでインストールしてみた。

事前に必要なもの

  • git
  • emacs
  • ruby-mode

yard-modeをgithubからclone

yard-modeをgithubからcloneしてきます。
emacsの拡張は、submoduleにして.emacs.d配下に突っ込むようにしているので、
今回も同様にしてます。

1
2
3
4
5
6
7
8
$ cd ~/.emacs.d
$ git submodule add https://github.com/pd/yard-mode.el.git

Cloning into 'yard-mode.el'...
remote: Counting objects: 75, done.
remote: Compressing objects: 100% (35/35), done.
remote: Total 75 (delta 36), reused 71 (delta 32)
Unpacking objects: 100% (75/75), done.

clone後は、.emacs.d配下にyard-mode.elというディレクトリが作成され、yard-modeのソースコードがその中に入っています。

init.elにyard-modeの設定記述

次に、~/.emacs.d/init.elファイルにyard-modeの設定を追記します。

init.el
1
2
(add-to-list 'load-path "~/.emacs.d/yard-mode.el")
(require 'yard-mode)

rubyファイルを開いた時に、yard-modeが有効になるように設定します。

init.el
1
2
(add-hook 'ruby-mode-hook 'yard-mode)
(add-hook 'ruby-mode-hook 'eldoc-mode)

うまく設定されていれば、こんな感じでハイライトされます。

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

Comments