From: maili31s@... (SugHimsi == SUGIHARA Hiroshi) Date: 2002-09-25T21:39:36+09:00 Subject: [ruby-list:36004] WeRDS (the Weekly Ruby-Doc Summary) 2002-09-22 --------_3D91AD244BFB01C915BC_MULTIPART_MIXED_ Content-Type: text/plain; charset="ISO-2022-JP" Content-Transfer-Encoding: 7bit すぎむし%くどいようですが、うるさければ謹慎しますので。 その他なんでも、ご意見あれば下さい。 ruby-docメイリングリスト、先週末までのサマリです。 [ruby-doc:00148] WeRDS, the Weekly Ruby-Doc Summary, for 2002-09-22 2002年09月22日時点のWeRDS (the Weekly Ruby-Doc Summary) です。 今週は(も)James Brittがお届けします。(日本語訳: すぎむし) 主なスレッド(Threads) ===================== ドキュメントを、オブジェクトとして? Hugh Sasse氏が、「ドキュメントはオブジェクトだ」という アプローチを提案した。クライアントのコードから、 SomeObject::Documentation.some_method と呼び出しできる ようにしよう、というわけだ。Jim Freeze氏は、RDocが、 このクラスを自動生成してくれたらいいのに、と示唆を与えた。 ドキュメントはコード埋め込み? それとも別ファイル? James Britt氏が、ドキュメントは「文芸的プログラミング」 (木村泉氏訳)[註0]風に、コードと一体で番をする方が好きだ、 なにもかも別々のファイルにしまいこんでしまうのはごめんだ、 と意見した。これには議論が続いて、それぞれを比べたときの 得失と、開発者にとってドキュメント作成をできるだけ面倒で なくするには、という話になった。 [0] http://www.literateprogramming.com/ 一口にドキュメントっていうけれど スレッドがもう一本、枝分かれした。こちらの話の焦点は、 APIのドキュメントとアプリケイションのドキュメントの違い であった。 XMLの果たせるもの Sean Chittenden氏は、rubydoc[1]のツールとして既に あるもの・提案するものが、いかに簡便かを説明した。 その特徴の核となるのがXMLであり、続く議論では、XMLが どのように、なぜ、どういった場面で、活用できるのか、 もしくはするべきであるのか、が論じられた。 [1] http://www.rubydoc.org ユースケイスで、われわれはどんな恵みを受けたか、そして なにがもたらされたか? James Britt氏は、正しく取り上げられた問題が一番よい 解決を見られるように、ユースケイス(あるいは似たよな もの)が、プロジェクトの要求にピントを合わせるのに 役立つようなものかどうかを知りたがった。Albert Wagner氏が、どこまでも続く枝別れの多い一連のポストを 追いかけていって混乱したと告白した。Jim Freeze氏は、 要求事項文書のヴァージョン2に向け作業中だと述べた。 内省的ドキュメント化 Rubyのリフレクション機能をどう活かすか、というアイディアが 流れた。Booker Bense氏は、「ソースがドキュメントだ」という 哲学に従いたい、と述べた。 はい、今週はここまで! --------_3D91AD244BFB01C915BC_MULTIPART_MIXED_ Content-Type: application/octet-stream; name="WeRDS_2002-09-22.en.txt" Content-Disposition: attachment; filename="WeRDS_2002-09-22.en.txt" Content-Transfer-Encoding: base64 IFRoaXMgaXMgV2VSRFMsIHRoZSBXZWVrbHkgUnVieS1Eb2MgU3VtbWFyeSwgZm9yIDIwMDItMDkt MjINCiAgQnJvdWdodCB0byB5b3UgdGhpcyB3ZWVrIGJ5IEphbWVzIEJyaXR0Lg0KDQoNCiAgICBU aHJlYWRzDQogICAgPT09PT09PQ0KICAgIERvY3VtZW50YXRpb24gYXMgT2JqZWN0Pw0KICAgICAg ICBIdWdoIFNhc3NlIHBvc2l0ZWQgYSAiZG9jdW1lbnRhdGlvbiBpcyBhbiBvYmplY3QiIGFwcHJv YWNoLiBUaGVuDQpjbGllbnQgY29kZSBjb3VsZCBjYWxsIFNvbWVPYmplY3Q6OkRvY3VtZW50YXRp b24uc29tZV9tZXRob2QuICBKaW0gRnJlZXplDQpzdWdnZXN0ZWQgaXQgd291bGQgYmUgbmljZSBp ZiBSRG9jIGNvdWxkIGF1dG8tZ2VuZXJhdGUgdGhpcyBjbGFzcy4NCg0KICAgIElubGluZSBkb2Nz IHZzLiBzdGFuZC1hbG9uZSBmaWxlDQogICAgICAgIEphbWVzIEJyaXR0IG9waW5lZCBhIHByZWZl cmVuY2UgZm9yIGRvY3VtZW50YXRpb24ga2VwdCB3aXRoIHRoZQ0KY29kZSwgYSBsYSBMaXRlcmF0 ZSBQcm9ncmFtbWluZyBbMF0sIGFzIG9wcG9zZWQgdG8gc3Rhc2hpbmcgZXZlcnl0aGluZyBpbnRv DQphIHNlcGVyYXRlIGZpbGUuICBUaGVyZSBlbnN1ZWQgYSBkaXNjdXNzaW9uIG9mIHRoZSByZWxh dGl2ZSBtZXJpdHMgb2YgZWFjaCwNCmFuZCBtYWtpbmcgZG9jdW1lbnRhdGlvbiBsZXNzIG9uZXJv dXMgZm9yIGRldmVsb3BlcnMuDQoNCiAgICBXaGF0IGRvIHlvdSBtZWFuIGJ5ICdEb2N1bWVudGF0 aW9uJz8NCiAgICAgICAgWWV0IGFub3RoZXIgc3ViLXRocmVhZCBlbWVyZ2VkLCB0aGlzIG9uZSBm b2N1c2VkIG9uIHRoZSBkaWZmZXJlbmNlcw0KYmV0d2VlbiBBUEkgZG9jcyBhbmQgYXBwbGljYXRp b24gZG9jcy4NCg0KICAgIFRoZSBSb2xlIG9mIFhNTA0KICAgICAgICBTZWFuIENoaXR0ZW5kZW4g ZGVzY3JpYmVkIGZhY2lsaXRpZXMsIGJvdGggZXhpc3RpbmcgYW5kIHByb3Bvc2VkLCBvZg0KaGlz IHJ1Ynlkb2MgWzFdIHRvb2xzLiBYTUwgaXMgYSBjZW50cmFsIGZlYXR1cmUsIGFuZCB0aGVyZSBm b2xsb3dlZCBhDQpkaXNjdXNzaW9uIG9mIGhvdywgd2h5LCBhbmQgd2hlcmUgWE1MIGNvdWxkIG9y IHNob3VsZCBiZSB1c2VkLg0KDQogICAgQ291bGQgd2UgYmVuZWZpdCBmcm9tIHVzZSBjYXNlcywg b3IsIHdoYXQgYXJlIG91ciBkZWxpdmVyYWJsZXM/DQogICAgICAgIEphbWVzIEJyaXR0IHdvbmRl cmVkIGlmIHVzZSBjYXNlcyAob3IgdGhlIGxpa2UpIGNvdWxkIGhlbHAgZm9jdXMNCnByb2plY3Qg cmVxdWlyZW1lbnRzLCB0byBoZWxwIGVuc3VyZSB0aGUgcmlnaHQgcHJvYmxlbXMgYXJlIHNvbHZl ZCB0aGUgYmVzdA0Kd2F5LiAgQWxiZXJ0IFdhZ25lciBjb25mdXNlZCBjb25mdXNpb24gZm9sbG93 aW5nIGEgbGVuZ3RoeSwgbXVsdGktdG9waWMNCnNlcmllcyBvZiBwb3N0cywgYW5kIEppbSBGcmVl emUgc2FpZCB0aGF0IHZlcnNpb24gMC4yIG9mIHRoZSByZXF1aXJlbWVudHMNCmRvYyB3YXMgaW4g dGhlIHdvcmtzLg0KDQogICAgSW50cm9zcGVjdGl2ZSBEb2N1bWVudGF0aW9uDQogICAgICAgIElk ZWFzIHdlcmUgZmxvYXRlZCBmb3IgZXhwbG9pdGluZyBSdWJ5J3MgcmVmbGVjdGlvbiBmZWF0dXJl cy4gQm9va2VyDQpCZW5zZSBzYWlkIGhlIHdvdWxkIGxpa2UgdG8gZm9sbG93IHRoZSBwaGlsb3Nv cGh5IG9mICJUaGUgc291cmNlIGlzIHRoZQ0KZG9jdW1lbnRhdGlvbi4iDQoNCiAgICBSZWZlcmVu Y2VzDQogICAgPT09PT09PT09PQ0KICAgIFswXSBodHRwOi8vd3d3LmxpdGVyYXRlcHJvZ3JhbW1p bmcuY29tLw0KICAgIFsxXSBodHRwOi8vd3d3LnJ1Ynlkb2Mub3JnDQoNCg0KVGhhdCdzIGl0IGZv ciB0aGlzIHdlZWshDQoNCg0K --------_3D91AD244BFB01C915BC_MULTIPART_MIXED_--