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

ruby-reference-manual:83

From: Minero Aoki <aamine@l...>
Date: Sat, 16 Sep 2006 23:10:23 +0900 (JST)
Subject: [ruby-reference-manual:83] Re: メソッドで使う定数の場所

青木です。

  In mail "[ruby-reference-manual:80] メソッドで使う定数の場所"
  sheepman <sheepman@s...> wrote:

> こんにちは、sheepman です。
> メソッドで使う定数の説明は離れた場所じゃなくて、
> メソッドの近くにあった方が良いと思います。また、現在の
> リファレンスはそうなっています。

> しかし、これは定数を

> 以下に置くという方針と矛盾します。
> File.rd に関しては取り敢えず定数をメソッドとして整形してコミットしておきました。
> どのように扱うのが良いでしょうか。

原則として定数は単独のエントリを立て、そこへリンクすべきです。

ただし flock に対する LOCK_SH のように明らかにメソッドと
定数が関連している場合は、メソッド側に主な説明を書き、定数
エントリの説明は簡潔にしてメソッドにリンクを張っておくのが
よいと思います。

ちなみに、今回の形式ではエントリの順番は一切保存されません。
また、エントリ単独のページもありますから、「近くに置く」
のは無意味です。

--
青木峰郎

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

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

        53 2006-09-13 03:50 [aamine@l...         ] 作業マニュアル #1 (フォーマット変換)    
        54 2006-09-13 17:13 ┣[kazuhiko@f...       ]                                       
        56 2006-09-13 17:35 ┃┗[aamine@l...         ]                                     
        55 2006-09-13 17:31 ┣[ko1@a...            ]                                       
        57 2006-09-13 17:59 ┃┗[aamine@l...         ]                                     
        73 2006-09-15 08:21 ┃ ┗[ko1@a...            ]                                   
        77 2006-09-16 01:01 ┃  ┗[aamine@l...         ]                                 
        58 2006-09-13 22:50 ┣[aamine@l...         ]                                       
        59 2006-09-13 23:19 ┣[itacchi@g...        ]                                       
        60 2006-09-13 23:56 ┃┗[aamine@l...         ]                                     
        61 2006-09-14 00:53 ┃ ┗[itacchi@g...        ]                                   
        62 2006-09-14 01:02 ┃  ┗[aamine@l...         ]                                 
        63 2006-09-14 17:36 ┣[sheepman@s...       ] ネストしたクラスと定数へのリンクの記法
        64 2006-09-14 18:21 ┃┗[aamine@l...         ]                                     
        66 2006-09-14 23:53 ┣[zn@m...             ]                                       
        69 2006-09-15 02:25 ┃┗[aamine@l...         ]                                     
        74 2006-09-15 21:35 ┃ ┗[zn@m...             ]                                   
        76 2006-09-16 00:59 ┃  ┗[aamine@l...         ]                                 
        67 2006-09-15 00:30 ┣[itacchi@g...        ]                                       
        78 2006-09-16 11:11 ┣[sheepman@s...       ] レベル 2 ブロック付きのドキュメント   
        79 2006-09-16 13:32 ┃┗[aamine@l...         ]                                     
        81 2006-09-16 17:06 ┃ ┗[sheepman@s...       ]                                   
        82 2006-09-16 23:25 ┃  ┗[aamine@l...         ]                                 
        80 2006-09-16 17:00 ┣[sheepman@s...       ] メソッドで使う定数の場所              
->      83 2006-09-16 23:10 ┃┗[aamine@l...         ]                                     
        89 2006-09-17 20:48 ┗[sheepman@s...       ] レベル 2 ヘッダ                       
        90 2006-09-17 21:19  ┗[aamine@l...         ]