高橋征義です。

TAKAO Kouji wrote:
> ただ、メソッドの処理結果によって、返り値がnilだったり多値(配列)だったり
> と、いくつかのパターンを取るメソッドがあると思いますが、どのように記述
> するのでしょうかね。
> 
> 例えば、以下のように複数の@returnを記述することになるのでしょうかね。
> 
>   @return nil
>   取得できなかった場合はnilを返します。
>   
>   @return a, b, c 
>   取得できた場合はaとbとcを返します。
>   aは...で、bは...で、cは...です。
> 
> それとも、以下のように@returnを一つ記述し、説明で全パターンを網羅するこ
> とになりますかね。
> 
>   @return
>   取得できなかった場合はnilを返します。
>   取得できた場合はaとbとcを返します。
>   aは...で、bは...で、cは...です。

某phpDocumentorは@returnに対応しているのですが、
そちらでのデータ型表現は、「mixed」という謎のdatatypeとして
まとめて使う場合と、「Foo|Bar」というように「|」で連結する表記を
使う場合があるようです。

# どっちかっていうと後者の方がよさそうですが。

参考まで。

高橋征義 (maki@r...)

--
ML: ruby-reference-manual@m...
使い方: http://QuickML.com/