トップ(最新)

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

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

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

最初の文

要約文を書く。

最初の文は

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

で終わる。

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

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

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

段落を分ける

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

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

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

スポンサード リンク

Related term

no diary

■よく検索されるキーワード

torrent(56) 提案書(47) perl(45) windows(37) linux(31) 使い方(27) 書き方(25) debian(22) x31(22) usb(22) cvs(20) subversion(20) インストール(18) ドラマ(18) c#(17) mp980(17) svn(17) 修理(17) 手帳(16) ssh(15) 評判(15) アジェンダ(15) java(15) デロンギ(14) ガントチャート(13) 感想(13) n-01a(13) centos(13) tc-1(13) 充電式カイロ(13) ノート(12) ダイソー(12) thinkpad(12) rcs(12) f-01a(12) ヤマダ電機(12) ganttproject(12) 無印(11) ppm(11) レビュー(11) カイロ(11) 壁紙(11) 静電気(10) 動画(10) バッグインバッグ(10) ヨドバシカメラ(10) サンプル(10) アジェンダとは(10) wiki(10) ミノルタ(10) グッズ(10) 作り方(10) tortoisesvn(10) firefox(9) so905ics(9) memcached(9) 画像(9) gmail(9) ハクキンカイロ(9) 口コミ(9) a6(9) sh-01a(9) 冷蔵庫(9) ほぼ日手帳(9) mp3(8) emacs(8) 日本語(8) openssh(8) xampp(8) カメラ(8) nikon(8) 設定(8) 写真(8) 値段(7) flash(7) 方眼(7) web(7) docomo(7) カバー(7) リポジトリ(7)

この日記のはてなブックマーク数 Add to Google RSS

Process Time: 3.057399s / load averages: 0.49, 0.54, 0.43
nDiki by WATANABE Yoshimasa (profile)
Powered by DiKicker
Base theme by Nana (for tDiary)