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

ruby-reference-manual:376

From: "toshiaki yamane" <yamanetoshi@g...>
Date: Thu, 8 Mar 2007 23:02:23 +0900
Subject: [ruby-reference-manual:376] Re: 第三段階実施要項 rev.3

こんばんわ。やまね@るりま初心者です。

> 質問なんですが、引数を取るメソッドの場合、
> 必ず @param を使わなければならない(MUST)ということでしょうか?

これ、自分も気になりました。

> 例えば、1行で説明が終るようなメソッドの場合、引数の説明にも同じ内容を
> 書くということでしょうか

FalseClass やら TrueClass の作業をしたんですが
メソッドの説明で全部言い切ってるのに、とは思ったのですが
引数があれば @param な記述は必要なのかな、と思い
相当無理矢理に引数の説明を入れてます。

ドキュメントのソースを見ていただければ微妙さ加減が分かるとは思うのですが、
一方で青木さんが
「ドキュメントの質については (あまり) 考えなくて構いません。」
と言われていた、という事で次の作業フェイズにて
このあたりの検討が実施されるのかな、と思い
軽い気持ちで ci している次第です。(すみません


regards,

----
Yamane Toshiaki

yamanetoshi@g...

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

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

       364 2007-03-02 16:31 [aamine@l...         ] 第三段階実施要項 rev.3                  
       367 2007-03-04 02:55 ┣[sheepman@s...       ]                                       
       368 2007-03-04 05:02 ┃┣[kouji@n...          ]                                     
       369 2007-03-04 08:40 ┃┃┗[maki@r...           ]                                   
       372 2007-03-08 11:45 ┃┗[aamine@l...         ] @return (was Re: 第三段階実施要項 rev.3)
       373 2007-03-08 12:18 ┃ ┣[aamine@l...         ]                                   
       377 2007-03-09 00:13 ┃ ┣[sheepman@s...       ]                                   
       383 2007-03-16 13:30 ┃ ┃┗[aamine@l...         ]                                 
       389 2007-03-24 04:21 ┃ ┗[sheepman@s...       ]                                   
       392 2007-03-24 08:37 ┃  ┗[aamine@l...         ]                                 
       375 2007-03-08 14:16 ┗[sheepman@s...       ]                                       
->     376 2007-03-08 15:02  ┗[yamanetoshi@g...    ]