株式会社クリアコード > ククログ

ククログ


Rubyで定義したメソッドの使用例をYARD用のドキュメントとして書く方法

はじめに

YARDというRuby用のドキュメンテーションツールがあります。APIのドキュメントの記述方法は大きく2種類ありますが、YARDはコードにコメントとしてドキュメントを埋め込む形式を採用しています。専用の記法を使って構造化された読みやすいドキュメントを書けることが類似ツールであるRDocとの大きな違いです。

今回は「Rubyで定義したメソッドの使用例を示す」ドキュメントのYARD流の書き方を紹介します。

なぜ使用例の書き方を説明するかというと、使用例を1つ示すだけで使い方をぐっとわかりやすく説明することができるからです。もちろん、引数や戻り値などメソッドについての情報も必要ですが、それらは断片的な情報なため、そこから全体像をイメージするにはもうひとステップ必要になります。一方、使用例は詳細を示すことには不向きですが、どんな状況で使うのか、どのように準備して使うのかといった前後関係も含めた全体像を示すことができます。

ライブラリーを初めて使うとき、最初にサンプルコードを動かして動作を確認した経験があるはずです。動作を確認し、サンプルコードの中の値を少しずつ変更して、実際に使うコードまで改良していったこともあるでしょう。このように、実際のコードで示された使い方はユーザーにとって有用な情報となります。

ユーザーではなく、ドキュメントを書く開発者の立場からも考えてみましょう。使用例を書くことで自分の作ったライブラリーのAPIが使いやすいかどうかを確認することができます。これは、よいソフトウェアを書くことに役立つことです。

このように、ドキュメントに使用例を書くことはユーザーにも開発者にもメリットがあります。

それでは、YARDで使用例を書く方法を次の順で説明します。

  1. YARDで使用例を書くために使う@exampleタグの使用例を紹介
  2. YARDで使用例を書くために使う@exampleタグについて説明
  3. Rubyのコードに実際に@exampleタグを使って使用例を書き、その出力を確認

@exampleタグの使用例

最初に使用例があるとわかりやすくなると説明したので、ここでも最初に@exampleタグの使用例を示します。詳細は後から説明します。

@exampleタグの同じ行に書いている「extract ages over 40」が使用例のタイトルで、それ以降のインデントされたコードが使用例になります。

1
2
3
4
5
6
7
8
# @example extract ages over 40
#   overages = extract_overage([17, 43, 40, 56], 40)
#   puts("overages: #{overages.join(", ")}") #=> "overages: 43, 56"
def extract_overage(ages, limit_age=20)
  ages.select do |number|
    number > limit_age
  end
end

どんな風に書くか雰囲気をつかめたでしょうか。

@exampleタグについて

それでは、@exampleタグについて説明します*1@exampleタグは、ドキュメント対象であるメソッドの使用例となるコードを示すために使います。後述するyardocコマンドを使って生成するHTMLのリファレンスマニュアルでは、コードが使用例だとわかるように整形されます。

@exampleタグの書式は次の通りです。

@example 使用例のタイトル
  使用例のコード

「使用例のタイトル」と「使用例のコード」に書く内容を説明します。

「使用例のタイトル」には、使用例を一言で示すような説明を書きます。@exampleタグは複数個同時に使用できるため、それぞれの例が区別しやすくなるような説明になっているか確認してください。「この使用例が注目していることはなんだろう」と考えるとよいタイトルをつけられるはずです。

使用例のタイトルは省略可能ですが、できるだけ書くようにしましょう。タイトルをつけられない使用例は何に注目しているかが散漫になっている可能性が高いです。そのような使用例はユーザーにとってわかりにくいものです。「何に注目しているか」を忘れずにタイトルがつけられる使用例を書いてください。

「使用例のコード」には、使用例として示したいコードを書きます。コードは@exampleタグの次の行以降に書きます。インデントすることを忘れないでください。インデントすることで、そのブロックにあるコードが使用例のコードであることを示します。

使用例を書くRubyのコード

次に、実際に使用例を書くRubyのコードを示します。

@exampleタグで使用例を書くコード(以降、「サンプルコード」と呼びます)は次の通りです。

1
2
3
4
5
6
7
8
9
10
11
12
# Generates Array containing numbers exceeding limit_age. Numbers is members of ages.
# For example, extract_overage([17, 43, 40, 56], 40) #=> [43, 56]
#
# @param ages [Array] numbers checked if they exceeded from limit_age.
# @param limit_age [Integer] limit_age limit used to extract
#   bigger ages than it.
# @return [Array] Returns Array containing numbers exceeding limit_age.
def extract_overage(ages, limit_age=20)
  ages.select do |number|
    number > limit_age
  end
end

この状態のサンプルコードからHTMLのリファレンスマニュアルを生成してみましょう。これは、使用例を書いたサンプルコードから生成したリファレンスマニュアルと後で比較するためです。

HTMLのリファレンスマニュアルを作成するには、YARDに付属するyardocコマンドを使用します。サンプルコードをexample.rbというファイルに保存して、次のコマンドを実行してください。

% yardoc example.rb

yardocコマンドを実行すると、次のようなリファレンスマニュアルができます*2

使用例なしのリファレンスマニュアル

@exampleタグの使い方

いよいよ、@exampleタグで例を書いていきます。

今回は使用例のタイトルに「extract ages over 40」を使い、使用例のコードは次のコードにします。

1
2
overages = extract_overage([17, 43, 40, 56], 40)
puts("overages: #{overages.join(", ")}") #=> "overages: 43, 56"

では、実際にサンプルコードのコメントに使用例を書きましょう。使用例の1つはすでにメソッドの全体の説明の中に「extract_overage([17, 43, 40, 56], 40) #=> [43, 56]」と書かれていました。その例を@exampleタグで書き直します。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
# Generates Array containing numbers exceeding limit_age. Numbers is
# members of ages.
#
# @example extract ages over 40
#   overages = extract_overage([17, 43, 40, 56], 40)
#   puts("overages: #{overages.join(", ")}") #=> "overages: 43, 56"
#
#
# @param ages [Array] numbers checked if they exceeded from limit_age.
# @param limit_age [Integer] limit_age limit used to extract
#   bigger ages than it.
# @return [Array] Returns Array containing numbers exceeding limit_age.
def extract_overage(ages, limit_age=20)
end
</code></pre>

コメント内で@exampleタグを書く位置はどこでもよいのですが、メソッド全体の説明の直後、引数や戻り値の説明の前に書くことをオススメします。これは、ドキュメントを読む側の視点で考えるとわかります。引数や戻り値の説明の前に使用例を見ておくと、その後の引数や戻り値の説明を理解しやすくなるからです。使用例を頭に入れてから引数や戻り値の説明を見ると、使用例で使われていた引数や戻り値に説明を引きあわせて考えることができるため、使用例を見ていない状態よりも理解しやすくなります。

使用例を書いたサンプルコードからyardocコマンドを使ってリファレンスマニュアルを生成します。生成したリファレンスマニュアルは次のようになります。

使用例ありのリファレンスマニュアル

HTMLのリファレンスマニュアルを見ると、赤枠の中に使用例のコードが表示されていることがわかります。

まとめ

YARDでは@exampleタグを使って使用例を書けることを実例を示しながら説明しました。また、HTMLのリファレンスマニュアルではどのように使用例が整形されるかも示しました。

今回は、YARDの書き方シリーズの4回目として@exampleタグを使った使用例の書き方を紹介しました。使用例を書くことで、実装したメソッドを実際にどう使えばよいのかをわかりやすく伝えることができます。今後、ドキュメントを書くときは、ユーザーに使いやすさを伝えるために使用例も書いてみてください。

これまでも次の通りYARDの書き方を説明しました。こちらも合わせて確認してください。

*1 タグというのはYARD専用の記法の1つで、コードのメタデータを記述するために使用します。詳細

*2 カレントディレクトリにできたdoc/top-level-namespace.htmlがこのリファレンスマニュアルに相当します。

2013-09-19

«前の記事: Autotools事始め 最新記事 次の記事: インターンの作業を進めやすくするための工夫»
タグ:
年・日ごとに見る
2008|05|06|07|08|09|10|11|12|
2009|01|02|03|04|05|06|07|08|09|10|11|12|
2010|01|02|03|04|05|06|07|08|09|10|11|12|
2011|01|02|03|04|05|06|07|08|09|10|11|12|
2012|01|02|03|04|05|06|07|08|09|10|11|12|
2013|01|02|03|04|05|06|07|08|09|10|11|12|
2014|01|02|03|04|05|06|07|08|09|10|11|12|
2015|01|02|03|04|05|06|07|08|09|10|11|12|
2016|01|02|03|04|05|06|07|08|09|10|11|12|
2017|01|02|03|04|05|06|07|08|09|10|11|12|
2018|01|02|03|04|05|06|07|08|09|10|11|12|
2019|01|02|03|04|05|