続 atsushifxの七転八倒

ウツ、発達障害の闘病記とIT関係のつれずれを書いていきます

Re; <a href="http://d.hatena.ne.jp/satoshis/20041006#p1">ドキュメントはどこですか?</a>

Javadoc を書くことにはテスト的な意味もある。どのようなクラスを作るのか。何をするためのメソッドを作るのか。テストを書くのと同様に、Javadoc を書くことで改めて頭の中で仕様を整理できる。

プログラマの意図をコードに反映させることが重要なんだけど、それは裏を返せば、コードに反映されているプログラマの意図を読み取らせ伝えることが、その目的だ。メソッド名や引数・戻り値の説明だけでは表現しきれない意図を(単なるコメントではなく) Javadoc に書いておくと、コードを読まなくてもコードの意図を伝えられるメリットもある。

トラックバックされたので読んでみたのですが、全面的に賛成。
やっぱ、Javadocくらい書こうよ。
今のシステムはAccess VBAなので**docは書けないんですが、ダイアログやプロパティは自分的に解りやすい名前をつけるようにしているし、変数名にはコメントをつけるようにしている。
やっぱし、そうしないと後でわからなくなるし。
ただ、名前のつけ方は難しい。
そういう意味で、変数名やクラスの変更などのリファクタリングが簡単に行える開発ツールや、名前の候補をつけてくれるツールがあると嬉しいです。