新井です。

From: Tadayoshi Funaba <tadf / kt.rim.or.jp>
Date: 25 Aug 2000 13:18:01 +0900
Subject: [ruby-list:24481] Re: RubyDocumentationProject(仮)

> ふなばです。

> でも、メソッドリストをつかうと、html に変換する際に、メソッドの引数に
> ついて特別の配慮がありますよね。そこにメソッドの記述はメソッドリストで

なるほど。でも、本当は、「特別な配慮」はしたくなかったという
のはあるのですよ。メソッドリストの実体はあくまでも最初の単語
だけをラベルとみなすもの。です。

--- 日本語 (英語)

    ((<日本語>))

なんてしてもまあよいわけです。

でも、欲はでるじゃないですか、引数は引数として見えて欲しい。
でも

--- method(((|var|)))

なんていちいち書きたくない

とか思う人もいますよね。このあたりは葛藤がでてきますし。思考
錯誤のあとです。その結果、中途半端なものになっていますが。後
の議論で固まるのではないかと、、、いやあ、甘かったですね。
# こういう葛藤が出て来ること自体、RDとMethodListが合わない証拠
# とも言えますね。

個人で書く分には書き方は御自由に。でも今回のようなプロジェク
トとしてまとまったドキュメントをあつめた場合、最終的に統一さ
れた書き方で書くことによって、「付加機能」をつけたい(メソッ
ドのindexingとか)。クラス名を書くのはそのための「慣習」を用
意したつもりです。

まあ、結局利便を求めたつもりが足枷になってしまったようですね。
ふぅ、むずかしいな。

以下の方向は、いかが?

(1) RD で --- (MethodList)は削除!

(2) 見出しの中の一部の語だけをラベルとみなす構文を用意する

: ((<method>))(arg1, arg2)

 ((<>)) の中だけをラベルとみなす。

(3) その上で RDの wrapper を用意する。以下のような書式をRDに変換する。

	=begin
	=class: Class

	==superclass: Object

	==classmethod:

	: new(var)

	==methods:



	==constants:



	= それ以外は普通にRD

	=end

  変換後は以下

	=begin
	= class ((<Class>))

	= superclass

	((<Object>))

	= Class Methods:

	: ((<new>))(((|var|)))

... とか。詰めるべき所はたくさんありますが、雰囲気は伝わります?

--
新井康司 (Koji Arai)