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

ruby-reference-manual:323

From: "Ken Date" <itacchi@g...>
Date: Tue, 20 Feb 2007 10:20:27 +0900
Subject: [ruby-reference-manual:323] Re: 第三段階実施要項

伊達です。

>    1. メソッドを一言で説明する文を一段落で書く。
>        この内容は自動抽出され、「メソッドの要約」として
>        クラスのページに出力される。特に内容に注意が必要。
>    2. 引数があれば、引数の情報を書く。
>      JavaDoc のような形式を使って、
>      「@arg pattern 検索するパターン」などと書く。
>    3. その他の注意事項を書く。
>    4. 使用例を書く。
>    5. 参照を書く。もしかすると @see を導入するかも

例外について Javadoc の @throw のようなものを導入する予定はありますでしょうか。
それとも 「3. その他の注意事項を書く」 に含めますか?

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

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

       320 2007-02-20 00:57 [aamine@l...         ] 第三段階実施要項                        
->     323 2007-02-20 02:20 ┗[itacchi@g...        ]                                       
       324 2007-02-20 02:26  ┗[aamine@l...         ]