nDiki : Javadoc ドキュメンテーションコメント

Javadoc ドキュメンテーションコメント

ドキュメンテーションコメント書き方(メモ)

最初の文

要約文を書く。

最初の文は

  • 直後にスペース、タブ、または改行が続く最初のピリオド (ロケール英語に設定されている場合)
  • 最初のスタンドアロンタグがある位置

で終わる。

クラスのコメントを書く (インタフェースでも同じ)

class の直前に書く。使用できるタグは

  • @see
  • {@link}
  • @since
  • @deprecated
  • @author
  • @version

段落を分ける

ドキュメンテーションコメントの中は HTML で記述するので p要素を使って段落をマークアップすれば良い。

ドキュメンテーションコメントのチェック

ドキュメンテーションコメントが正しく記述されているかをチェックするツールとして、DoctorJ がある。

スポンサード リンク

no diary

About Me

Naney Naney

Naney (なにい)です。株式会社ミクシィで SNS 事業の部長をしています。

About nDiki

nDiki1999年1月に始めたコンピュータ日誌を前身とする NaneyWeb 日記(兼パーソナルナレッジベース)です。

#nNote タグがついている記事は他の記事に比べて、より断片的・未整理・不完全なちょっとしたノートです。まだ結論に至っていない考えなども含まれます。頻繁/大幅に更新したり削除したりすることがあります。

※本サイトの内容は個人的見解であり所属組織とは関係ありません。

Other Notes

ナレッジベースアプリケーション Obsidian で書いているノートの一部を notes.naney.org で 公開しています。

最近検索されている記事

月別インデックス
Process Time: 0.049277s / load averages: 0.23, 0.29, 0.29
nDiki by WATANABE Yoshimasa (Naney)
Powered by DiKicker