タグ

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

  • 関連タグはありません

タグの絞り込みを解除

documentとjavadocに関するbobbyjam99のブックマーク (1)

  • [Think IT] 第2回:「どんなシステムを作るのか」をJavadocで表現する (1/3)

    Javadocの機能は、ソースコード中の「/**」と「*/」で囲まれたドキュメンテーションコメントから、リファレンスドキュメントを生成することでした。ソースコードとドキュメンテーションコメントが一体になっているため、開発者は設計を考えながらソースコードを書き、その設計内容をドキュメンテーションコメントとして残すといった一連の流れをソースコード上で行うことができます。 Javadocは、標準クラスライブラリのリファレンスドキュメントを見れば、クラスやメソッドの使い方を理解するのにとても役に立つことはわかります。しかし、システム開発現場のドキュメントとしては、それだけでは不十分です。 Javadocに足りないのは「ソースコードが正しいか」ということを表現できないことです。正しさを確認するには2つの視点があります。1つは「どんなシステムを作るのか」という視点。もう1つは「どのように検証するのか」

    bobbyjam99
    bobbyjam99 2007/09/04
    Javadocに仕様書とのリンクを記述することが出来るカスタムspecタグ紹介.ダウンロードもあるよ.
  • 1