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

ruby-reference-manual:474

From: sheepman <sheepman@s...>
Date: Mon, 27 Aug 2007 09:01:37 +0900
Subject: [ruby-reference-manual:474] Re: メソッドの説明中の例の位置

こんにちは、sheepman です。

On Mon, 27 Aug 2007 05:50:01 +0900
Minero Aoki <aamine@l...> wrote:

> 
> まず、ここで言及されている「例」はよく見ると二つのパターンがあると
> 思います。一つめは文章を補足する形で入れられている「コード例」、
> 二つめは単独で意味をなす「コード例」です。
> 

二つの違いが良く分かりません。例というのは常に文章を補足するためのものなんじゃ、
と思いました。とりあえず、前者は「レアケースの例」、後者は「一般的な使用例」
だと理解しました。

論点は二つ。

1. 「一般的な使用例」を後ろに書いちゃうとその挙動を説明する文章と離れるわけ
ですが、それはどうしましょう。

2. あるコード例が二つのうちのどちらなのか明確である場合は少数だと思います。日本語だけでは
理解が難しい時に文中に一般的な使用例を書いて補足するケースが多いはずで、それは青木さんの言う
前者なのか後者なのか良く分かんないです。このまま基準を不明確にしておくと、文章中の例を単に
文末にカットアンドペーストするだけになってしまいそうです。

>  例えば Class.new の場合は直前にある「最初に名前を求める際 
>  に代入
>  されている……」というくだりを実例で示している、の  ** だ 
>  ろうなあ**
>  とはわかるんですが、明確に書いてあるわけではありません。直前の
>  段落に「以下にその例を示します」とかなんとか書いてあればちょっと
>  違ってくるでしょうが、いまの文章では舌足らずです。

同意します。時間があればやってみようと思います。

> 
> さらに言えば、使用例は必須です。
>

はじめて聞きました。

-- 
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...         ]