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

ruby-reference-manual:276

From: okkez <okkez000@g...>
Date: Sat, 6 Jan 2007 21:14:00 +0900
Subject: [ruby-reference-manual:276] ドキュメントファイル分割の基準と方法

okkezです。

src/tk/ 以下が凄いことになってきているので少し整理しました。
# *.off を src/tk/off/ 以下に移動しました。

ドキュメントを書くときに、エントリが多い場合は複数ファイルに分割すると思いますが、私が認識している手順とは違う手順で作業がすすんでいるようなので確認させてください。
# どこかでこの件に関する記述を見た気がするのですが見付けられませんでした。

# tk/* の場合です。
1. src/tk/library_name.rd を作成( tk/library_name.rb に対応)
2-1. 該当ライブラリに含まれるクラスが少ない場合 library_name.rd にそのまま記述
例えば、 tk/optiondb の場合は、含まれているモジュールが二つだけなので src/tk/optiondb.rd に二つとも記述しました。
2-2. 該当ライブラリに含まれるクラスが多い場合複数ファイルに分割
例えば、tk/canvas の場合、12個のクラスやモジュールが定義されているので分割すると思います。
src/tk/canvas.rd を作成し、#@includeでファイルを読み込むように記述する。
src/tk/canvas/以下に、クラスごとにファイルを作成する。
# でないと別のライブラリでクラスをreopenする記述がし辛いハズ
しかし現状は、src/tk/ 以下に、ずらーっとクラスごとのファイルが展開されています。
# ファイルの配置だけでは、どのクラスがどのライブラリで定義されているのかわかり辛い

tk ライブラリで定義されていたクラスやモジュールは src/tk/ 以下に直接置いていますが、これは2-2の通りに作業した結果です。また、
tkutil や tcltklib についても同様です。

まとめると、
* tk.rb で定義されているクラスを別ファイルに分割した場合は、 src/tk/ 以下に直接置く
* tk/library_name.rb で定義されているクラスを別ファイルに分割する場合は、 src/tk/library_name/ 以下に置く
ということになります。

以上、私の認識に誤りがなければこのように作業したいのですが、いかがでしょうか。

-- 
okkez
okkez000@g...

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

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

->     276 2007-01-06 13:14 [okkez000@g...       ] ドキュメントファイル分割の基準と方法    
       277 2007-01-06 13:39 ┣[don@n...            ]                                       
       284 2007-01-06 22:33 ┗[moriq@m...          ]                                       
       299 2007-01-07 07:02  ┗[okkez000@g...       ]                                     
       301 2007-01-07 08:48   ┗[don@n...            ]