今日の役に立たない一言 - Today’s Trifle! -

古い記事ではさまざまなテーマを書いていますが、2007年以降はプログラミング関連の話がほとんどです。

上の話題の続き

id:swatたんにTバックをもらったので、もうちっと補足。

要は、ソースコードや、そのソフトウェアの動作をそのまま日本語で説明するドキュメントを書いている限りは、意味は無いんだろう。それこそ「ソースを追いかけたほうがはやい」ということになる。

だから「プログラマの意図を反映させてあるJavadocを書こうよ」ということ。
Javadoc をちゃんと書かない人は、命名にも気を使わないだろうし、依存の方向にも気を使わないだろうし、可読性にも気を使わないんだろうし。。。
あ、もしかすると Javadoc コメント書かないのは、「コードを読むついでにレビューしてね」というプログラマの意図だったりして。それならちゃんと意図が反映されてるからOKじゃん。(違)