mieki256's diary

キャラ画像については、そのままバイナリに組み込んでOK的返事が来たので、組み込んでバイナリを送ったり。ホントにアレでいいのかなと思わないでもないけど。修正してないよりは、修正してあるほうがまだマシだろう…。

さておき。ソースについての説明文書も後々提出を求められるはずなので、今のうちに Javadoc(変数やメソッドに対する説明が列挙されてるhtml)生成作業を試してみようかと。

eclipseで、プロジェクト→Javadocの生成、を選ぶだけで、Javadocは生成してくれる。のだけど。説明文章は、変数やメソッドの直前に書いたコメントをそのまま使うので、そこの記述がおかしい・足りないとアレなわけで…。ということでソースのあちこちを修正。でも、とてもじゃないけど全ての変数にコメントをつけていられない。

いや、実は既にコメントはついてるんだけど、ほとんどが「// 〜」の形なわけで。javadoc用に参照されるコメント形式は、

/**
 *
 */

なんだよなぁ…。1行で済んでたものが4行ほどになってしまう。ソースの見通しが非常に悪くなる感も。連番で定数定義してるところなんかは、1行から4行になるだけで、バグの温床になりそうな。

でもまあ、その手の文書を提出しろと言われるのであれば仕方ない。でも、提出したとしても、誰が読むんだろうな。いやまあ、不具合が出て、かつ、開発元や担当者がつかまらないときは、読んだりもするのかなと想像してるんですが。