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

ruby-reference-manual:82

From: Minero Aoki <aamine@l...>
Date: Sat, 16 Sep 2006 23:25:51 +0900 (JST)
Subject: [ruby-reference-manual:82] Re: レベル 2 ブロック付きのドキュメント

青木です。

  In mail "[ruby-reference-manual:81] Re: レベル 2 ブロック付きのドキュメント"
  sheepman <sheepman@s...> wrote:

> こんにちは、sheepman です。

> > クラスのドキュメントに移すか、全メソッドエントリにコピーするか、
> > どちらかで対応してください。Float の場合はクラスのドキュメントで
> > よいと思います。

> 説明文をコピーしてまわるのは DRY ではないので、何かコピーせずに済むような
> 機構が今後導入されることはありますか。

乗り気ではありません。日本語の文章は人間が読まないとテスト
できないので、書く労力よりもテストする (読む) 労力を減らす
ほうが重要です。できるだけ出力そのままの文章を置いておくのが
テストしやすい (読みやすい) ですから。

また、今回の場合は本当にコピーすべきなのか疑問でもあります。

これは明らかにコピーしたほうがよいと思えて、しかもそれは
#@include では解決できないというケースが 3 つ以上見付から
ない限り、粒度の小さいモジュール化機能は導入しません。

--
青木峰郎

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

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

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