こんばんは、sheepman です。

メソッドのエントリーの書き方の確認です。
以下の例のように

> --- method
> ここに要約。ここに要約。ここに要約。ここに要約。
>
> そのほか説明。そのほか説明。そのほか説明。そのほか説明。
> そのほか説明。そのほか説明。そのほか説明。そのほか説明。
> 
> @xxx
>
> 例例例例例例例例例例例例例例例例例例例例例例例例例例例

というふうに、一行目に要約を書いて、そのつぎに詳しい説明を書く。
それから @xxx と例を書くと理解しているのですが、青木さんはどのような
書き方を想定していますか。

String#[]
http://doc.loveruby.net/refm/api/view/method/String/i/=5b=5d

をみる限りは上のとおりだと思うのですが。

http://doc.loveruby.net/refm/api/view/method/Precision/i/prec

などのように @xxx を文の途中に書く例があったので、確認したいと思います。

http://doc.loveruby.net/wiki/HowToWriteMethodEntry.html
も誤解を招きやすい文章と言えばそうですが。

-- 
sheepman / TAMURA Takashi
sheepman@s...

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