shirasagi/shirasagi — pull request #27 by gouf (2014-09-18 15:22:32+00:00)
Title: YARD Ruby Documentation Tool

ドキュメント生成ツール、YARD gem を追加します。

下記のように、メソッドに概要、パラメータ、戻り値を記述することで、ドキュメントを自動生成することが出来ます。

>
```
# Converts the object into textual markup given a specific format.
#
# @param [Symbol] format the format type, `:text` or `:html`
# @return [String] the object converted into the expected format.
def to_format(format = :html)
# format the object
end
```

正しく記述できているかは```yard server``` コマンドでWeb ブラウザから確認することが出来ます。

### Links
* [YARD - A Ruby Documentation Tool](http://yardoc.org/)
* [lsegal/yard - GitHub](https://github.com/lsegal/yard)
* [GettingStarted · lsegal/yard Wiki - GitHub](https://github.com/lsegal/yard/wiki/GettingStarted)