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

ruby-reference-manual:428

From: sheepman <sheepman@s...>
Date: Sat, 23 Jun 2007 18:28:34 +0900
Subject: [ruby-reference-manual:428] ドキュメントを書く以外にやること

こんにちは、sheepman です。

ドキュメントを書くというのは ToDo として共有されていると思うので、
それ以外で気付いたものを書きます。

デザイン関連
* 引数や例外の説明部分のデザイン。現在は素のまま出力されている @param, 
  @raise の部分を利用者に分かりやすく(HTMLとCSSを)デザインする。
* メソッドの返り値の型も もう少し見やすくならないか?

ドキュメントの文法
* @param, @raise 関連の文法を確定する。BitClust でパースされていないので、
  複数行を書いて良いかなどがはっきりしない。
* 現在 unknown になっている一般的なドキュメントへのリンクの仕方。

BitClust 関連
* @param, @raise のパース。
* 一般的なドキュメントへのリンク。

それでは。

-- 
sheepman / TAMURA Takashi
sheepman@s...

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

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