Javaのソースコード中にコメントとして記述するドキュメンテーションの規約および、その規約に従って書かれたソースコードから抽出したドキュメンテーションのこと。
概要
Javaのコメントには、次の三種類がある。
- "//" から行末まで
- "/*" から "*/" まで
- "/**" から "*/" まで
このうち、最後のものがjavadocコメントと呼ばれる。
これをツールで加工することにより、HTMLをはじめとしたさまざまな形式のドキュメントを生成することができる。
例
/**
* 他のオブジェクトがこのオブジェクトと等しいか否かを識別する。
* @return 等しいならtrue、そうでないならfalse
* @param o 比較対象となるオブジェクト
* @see #hashCode()
*/
public boolean equals(Object o) {
//
}