mieki256's diary

最終提出時にはソースについて説明した文書が必要らしいので、昨日弄ってたJavaアプレットのソースを使って、eclipseから操作してJavadocを試しに出力してみたり。

メソッド等の概略の一文がどこで区切られるのかがよく判らず。検索してみたところ、「.」(ピリオド)+改行で区切られるらしい。が、どうも昨今のJavadocでは「。」+改行も区切りとして認識してくれる模様。たぶん。

基本的には、public指定したメソッド・フィールド等について出力することが多いらしく、その点についてはちょっと頭を抱えてしまった。自分のiアプリのソースは、private指定してる箇所がほとんどなわけで…。パッケージ中の全てのソレを出力するようにオプションを与える(というかeclipseからの操作時に「private」を選ぶ)しかないか…。

自分のiアプリのソースは、フィールド(メソッド変数？)のコメントが「// 〜」なのもちょっと困ったなと。Javadoc は、「/** 〜 */」しか見てくれないらしいし…。ソース中の「// 〜」を「/** 〜 */」に書き換えていくしかないか。

しかしコメント部分を変更するためだけに、ソースを編集してしまうのもどうなんだという感も。また、「// 〜」なら1行で済むところを、「/** 〜 */」にすると3行になってしまうのも見た目的になんだかなと。Javadocを使うこと前提でソースを書いてることを知らない人が見た場合、「なんでコイツ、こんなわけの判らない書き方をしてるんだ？」と思われてしまうのだろうな…。