読者です 読者をやめる 読者になる 読者になる

README.java

Java

id:shot6さんがLucyのサンプルを書いたから要チェケラと言っていたので、見てみたら「README.java」っていうJavaコードだった。
http://code.google.com/p/t-2/source/browse/trunk/lucy-examples/src/README.java?r=2407


よく考えてみると、

  • JavaDoc形式になる
  • 勝手にクラスにリンクが張られる
  • IDE上でみるとキーワードがハイライトされる
  • うまくすればそのまま動作させられる
  • うまくすればREADMEドキュメントがリファクタリングできる


などの特典があり、あながちkimoyと言いいきれないと思いました。
SVNをお持ちの方は、上記URLから一度チェケラアウトしてみるといいと思います。


なお余談ですが、昔JAXPの単体配布は「JAXPなんとか.class」というファイルで行われており、このクラスをコマンドラインで「java JAXPなんとか」で実行すると、クラスファイル内部で保持しているバイナリデータを解凍してjarやらドキュメントを吐き出す、というような実装がされていた記憶がありますが、なぜSUNがそんなことをしたのか、三十路を超えた今でも理解できません。