Search Results: tag:yard

10 件ヒットしました。

yard ruby ブロックの説明を書く

ブロックの説明を書くには @yield, @yieldparam, @yieldreturn を使用する。

# @yield [a,b] Description of block
# @yieldparam a [String] Description of parameter a
# @yieldparam b [Fixnum] Description of parameter b
# @yieldreturn [Array] Description of returned value

yard ruby 注意書き(ノート)を書く

# @note Some description
# def some_method

のように @note を使う。

yard ruby メソッドと引数の行を変更する

メソッドと引数を記述した行は yard が自動的に作ってくれるが、 表示を変更したい場合がある。 そのようなときは @overload で次のように記述する。

# @overload initialize(arg1, arg2 = 1)
#  @param arg1 Description1
#  @param arg2 Description2

C 拡張ライブラリの可変長引数のときは yard がうまくやってくれないので @overload を利用するとちょうどよい。

yard ruby ドキュメント生成にキャッシュを使う

キャッシュを使う。標準だと使用しないことになっている。

yardoc -c

yard ruby yard のコマンドライン引数を保存する

.document に書く。 たとえば

lib/**/*.rb
bin/*
-
LICENSE.txt
docs/**/*.md

のようにする。

yard ruby YARD のドキュメントをブラウザで見る

yard server --reload

でサーバを起動して http://localhost:8808 にアクセスする。

yard ruby 例を記述する

@example タグを使って、下に続く例は字下げする。

# @example A server over ssh
#  server(:server_ssh, "example.co.jp") do |server, ssh|
#    server.load "server_definition.rb"
#    server.acl "/path/to/acl"
#    ...
#  end

yard ruby 返り値を記述する

@return を使う。

# @return [Array] an array of pair [name symbol, definition hash]
# Keys of the hash are :type, :template, :ssh, :setting, and :args.
attr_reader :__server__, :__node__

yard ruby オプション引数を記述する

@param でパラメータについて書いた後に、@option でキーと値について書く。

# We can set default server, default port, ... .
# @param [Hash] val the pair of key and value
# @option val [Fixnum] :port Port number of a server
# @option val [Symbol] :server Server executed by default
def default(val = {})

yard ruby リンクを張る

オブジェクトにリンクを張るには { と } で囲んで

{SomeClass#some_method}

とする。URL やファイルにリンクを張るには

{http://example.com}
{file:/tmp/file.txt}

などとする。