[前][次][番号順一覧][スレッド一覧]

ruby-reference-manual:455

From: sheepman <sheepman@s...>
Date: Sun, 12 Aug 2007 23:59:18 +0900
Subject: [ruby-reference-manual:455] メソッドの説明中の例の位置

こんばんは、sheepman です。

メソッドの説明中の例の位置に関してです。

http://doc.loveruby.net/wiki/HowToWriteMethodEntry.html

で、例は最後にまとめるということになっていることに最近気がつきました(笑)。
これだと、例とそれを説明している文章が離れてしまいます。例の位置はもう少し
柔軟に対処しちゃいけないでしょうか。

現在の仕様は UNIX の man を踏襲したものだと思います。
man の場合は、 
 * そもそも例の量が少ないので例と説明との対応を気にするほどではない 
 * C 言語だとひとつの例の行数が多くなってしまうために、文中に挿入することが難しい
という理由があって、後ろにまとめているのだと思います。

Ruby のリファレンスの場合は、例が割と多くて、個々の例の行数は短いので
説明の本文の間に入れてもおかしくないと思うのですが。どうでしょうか。

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

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

[前][次][番号順一覧][スレッド一覧]

->     455 2007-08-12 16:59 [sheepman@s...       ] メソッドの説明中の例の位置              
       456 2007-08-12 18:25 ┣[eklerni@f...        ]                                       
       457 2007-08-13 06:16 ┣[okkez000@g...       ]                                       
       458 2007-08-13 14:43 ┃┗[eklerni@f...        ]                                     
       472 2007-08-26 22:50 ┗[aamine@l...         ]                                       
       474 2007-08-27 02:01  ┗[sheepman@s...       ]                                     
       479 2007-09-02 20:30   ┗[aamine@l...         ]