Cプログラマに贈るJavaの学び方(第2章)必要なのは資料

次にJavaDocの完備。Cプログラマだと、紙ベースが基本で、必要ならwordファイルかpdfという感じじゃないかと。JavaDocはソースコードから自動生成されるドキュメントで、まともなプロダクトならばまず間違いなく付いてくる。その文化は見習うべきものだ。メソッド毎に決められたフォーマットで書けばクラスドキュメントのできあがり。Eclipseを使っていれば、メソッドの直前で「/**」に続けて改行すれば、引き数や返り値のひな型を組み込んだコメントを生成してくれる。
そのJavaDocを使うライブラリすべてについて揃えておくのだ。英語でもぜんぜん気にせず揃えるのがコツだと思う。何せ初心者だ。そのHTMLを全文検索することで何かヒントが得られるかもしれないし。

次に揃えるのはソースコードだろう。嬉しいことにランタイムや、有用なライブラリ群は殆どがソースコードを配布してくれている。そこから何かヒントをもらえることも少なくない。動きがおかしいと思ったら中を見ることもできる。
Eclipseならば、ソースコードのjarを登楼するなどしておくと、メソッドの一覧表示の際にそのメソッドに対するJavaDocまで表示する。メソッドの上でF3を押せばJARの中まででも探してソースを表示する。

JavaDoc、プロダクトソースという間違いの少ない良質なサンプル、手本を手にいれるのだ。ウェブ上であふれるサンプルは玉石混合だ。それはJavaに限ったことでないのは皆ご存じのことだろう。