青木です。

On 2007/08/08, at 23:44, sheepman wrote:

> こんばんは、sheepman です。
>
> メソッドのエントリーの書き方の確認です。
> 以下の例のように
>
>> --- method
>> ここに要約。ここに要約。ここに要約。ここに要約。
>>
>> そのほか説明。そのほか説明。そのほか説明。そのほか説明。
>> そのほか説明。そのほか説明。そのほか説明。そのほか説明。
>>
>> @xxx
>>
>> 例例例例例例例例例例例例例例例例例例例例例例例例例例例
>
> というふうに、一行目に要約を書いて、そのつぎに詳しい説明を書く。
> それから @xxx と例を書くと理解しているのですが、青木さん 
> はどのような
> 書き方を想定していますか。

上記で想定通りです。

再度確認すると、@param とか @return は独立した段落  
(あるいは行) で
記述する追加情報です。JavaDoc の同名のタグと同じようなもの 
だと
思ってもらえればよいでしょう。

--
青木峰郎

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