タグ

関連タグで絞り込む (1)

タグの絞り込みを解除

ソフトウェア開発と仕様書に関するatsushifxのブックマーク (1)

  • Javadoc の書き方 - イトウ アスカ blog

    みなさん、Javadoc 書いてますか? Javadoc は「API ドキュメント」と言われることが多いように、主にライブラリ的なプログラムで書いてこそのものだと思っている方もいるかもしれません。しかしながら、仕様書を Word や Excel(笑)で別途作ると、プログラムと仕様書の同期がとれてないというはめに陥り易くなりますので、Javadoc はどんなときも活用したいというのが私の考え方です。 まず、overview.html を書け Javadoc コメントをいくらか書くような人でも、overview.html を書く人は意外と少ないのではないでしょうか。リファクタリングが何度となく行われるアジャイル開発の現場では、クラスの構成がよくかわりますので、いちいち詳しいコメントを書いていられないということはあるかもしれませんが、overview.html はそれほど何度も手をつけるようなも

    Javadoc の書き方 - イトウ アスカ blog
    atsushifx
    atsushifx 2009/04/30
    仕様書として使うためのJavaDocの書き方
  • 1