へなちょこSEの考察

0x1E歳のへなちょこSEが、日々思うことを考察します。自社内、金融系を経て現在法人系PKG開発に従事。

Javadocの書き方

良いブログ記事があったのでメモ。


yamkazu-bookの日記:エンジニアのためのJavadoc再入門講座

紹介されてる本が欲しくなりました。


個人的には、詳細設計書を作るのやめて、Javadocを充実させるほうが良いと思っています。
ビジネスロジックは明確に定義しておくべきですが、それを達成するためのロジックはプログラマに任せたほうが、いろいろといいことがあると思うんですよねー。


あと、設計書と実装が乖離している場合。
製造当初であれば、設計書と実装が合っていなかったら実装が悪いということになりますが、リリースした後になると、動いているのは実装になるので、今度は設計書が悪となります。
これってなんかおかしな状況だなーと思うんです。


あとはSQL設計書ね。
SQL設計書なんて日本語で書くくらいなら、設計者がそのままSQL書いちゃえば良いんじゃないかと思っちゃいます。
で、SQLを解析してテーブル名とかを日本語置換してくれるマクロでも組めばいい。
そうすれば、ある程度の読みやすさは担保できるはず。


僕が今までやってきたプロジェクトだと、設計書があってそれを元に実装します。
それって、プログラマは「翻訳家」でしかないんですよね。
そのうち「機械翻訳」に取って代わられてしまうことは間違いない。
「翻訳家」ではなくて、「クリエイター」なり「デザイナー」であることが、これからのプログラマには求められるのではないかなぁと思っていたりします。