From: Akihiro Furudo <A.Furudo@...>
Date: 1998-10-12T11:45:31+09:00
Subject: [ruby-list:9992] What is good sample code?(Re:[9888])


札幌の古堂です。

> From: ttate@jaist.ac.jp
> Subject: [ruby-list:9888] Re: 文字化け失礼、再送
> Date: Thu, 8 Oct 1998 22:28:11 +0900
> Message-ID: <19981008222153J.ttate@jaist.ac.jp>

> 立石です。

> やっぱりマニュアル類の不足は否めないような気がします。

例えば、エンドユーザが使うワープロとか、家計簿ソフトとか、そんなのだっ
たらマニュアル類も、必要でしょう。でも、ライブラリなんかのときは、むし
ろサンプルプログラムや、ライブラリのプログラム自身が解りやすいことが必
要じゃないでしょうか。

みんな忙しいのですから、そんなレベルまでドキュメント整備していたら、書
くのも読むのも大変でしょう。せっかくperlより可読性の高い言語使ってんで
すから、むしろ「有用なサンプルプログラム(あるいはライブラリテスト用プ
ログラム？)とはどんなものか。どんな人を『読者』として想定するのか」
「わかりやすいライブラリ仕様とは何か」とかをお互い考えて、書くべきドキュ
メントを最小限にして、そのドキュメントを「きちんと書く」ことを目指した
ほうがいいでしょう。

UNIX関連本の中には、「○○のソースは××から読め。そうすれば解る」と指
導していたモノもあったと記憶しています。こんなドキュメントが役に立つケー
スの方が稀でしょうが。

					古堂明広/a.furudo@luvnet.com