mieki256's diary

YARDてのは、Rubyのスクリプトソースの中に、ある決まったフォーマットでコメントを書いておくと、そこからドキュメントを作ってくれるツール、という認識でいいのかしら。

yardoc hoge.rb

てな形で実行すると、doc/ フォルダを作ってその中にhtmlでドキュメントを生成してくれる模様。

それらしいドキュメントを出力してくれた。ありがたや。しかし、一部書き方が分からないところが。

• クラス内の定数について説明を書きたい場合はどういうコメントを書けばいいのか。
• return a, b といった形で、複数の戻り値がある場合は、Array 扱いでいいのかどうか。
• 戻り値が int、Boolean、nil 等に変わる場合は、どういう書き方をすればいいのか。「@return」を複数書くらしいけど、出力されたソレが、「int, ... 」となってしまって。「int?」になる、と巷の解説ページには書いてあるのだけど。

ググってみても、そのあたりを解説してあるページには辿り着けず。