Tbpgr Blog

Ruby プログラマ tbpgr(てぃーびー) のブログ

Ruby | YARDを導入

概要

YARDの導入

内容

JavaDocライクな記法でRubyAPIドキュメントを生成できる
YARDを導入します。

インストール

Gemfileに以下を追加

gem "yard", "~> 0.8.6.2"

またはgemのインストールを行う

gem i yard

サンプル

サンプルコード

hoge.rb

# hogeクラス
class Hoge
  # hoge定数
  CONST="hoge"
  attr_accessor :hage, :hige

  # level1
  #
  # @param [String] value
  # @return [String] 引数に"hoge"を加えた文字列
  def self.class_hoge(value)
    value + "hoge"
  end

  # level1
  #
  # @param [String] value
  # @return [String] 引数に"hoge"を加えた文字列
  def hoge(value)
    value + "hoge"
  end
end
実行
yardoc --charset UTF-8 hoge.rb
結果