コーディング規約 トップページJava コーディング規約 目次 

1.7 JavaDocのコメント

JavaDocのコーディング規約と互換性を保つため、メソッドに関するほとんどのキーワードは対応している。
ただし、<B>などのタグは削除されドキュメント化される。
また、キーワードの追加変更も可能になっている。

■JavaDocのコメントの例

  /**
   * JavaDocの説明でも、これらのタグはコメントを抽出できます。
   * 複数行にまたがった説明も記述できます。
   *
   * @param 引き数はこのように記述します。
   * @return 返り値はこのように記述します。
   * @author 作成者はこのように記述します。
   * @version バージョンはこのように記述します。
   * @since 導入バージョンはこのように記述します。
   * @see 関連項目はこのように記述します。
   * @exception 例外はこのように記述します。
   * @deprecated 説明はこのように記述します。
   */
  private void JavaDoc()
  {
   /// メソッド内のコメントはこのように記述します。
  }