タグ

Javaとjavadocに関するoinumeのブックマーク (3)

  • Javadocメモ(Hishidama's Javadoc Memo)

    概要 Javadocは、Javaの特殊なコメント。 コメントの書き方がルール化され、それを元に説明書を作成することが出来る。 クラス・メソッド・フィールド(変数)にJavadocコメント(説明)を付けられるので、それらの説明が見られることになる。 Javadocと言った場合、「Javadocコメントの書き方」と、それを元に生成された「API仕様(HTML文書)」のいずれかを指すことが多い。 後者は、Javaの(標準ライブラリーの)API仕様が有名。→Javadocの読み方(入門者向け) Javadocの記述方法はHTMLがベースだが、Java23でマークダウン形式のJavadocが書けるようになった。 [2024-09-22] Javadocの生成方法 Javadoc生成用のコマンドを使って、JavaのソースファイルからHTMLを生成する。 javadocコマンド … これが一番基 Ec

  • いつ、どのように API を非推奨とするか

    「非推奨」の意味すること いつ非推奨とするか 非推奨とする方法 @Deprecated 注釈の使用 @deprecated Javadoc タグの使用 「非推奨」の意味すること 「自虐的 (self-deprecating) ユーモア」という言葉を聞いたことがあるかもしれません。つまり、自分自身を低めるユーモアのことです。非推奨 (deprecated) のクラスまたはメソッドは、それに似ています。もはや重要ではなくなったのです。つまり、そのクラスやメソッドの重要性は著しく低下しており、現在では他 のクラスやメソッドに置き換えられていたり、将来は存在しなくなる可能性もあるため、今後は使用するべきでないことを意味しています。 Java では、非推奨を表現する手段を提供しています。それは、クラスの発展に伴い、その API (アプリケーションプログラミングインタフェース) も必然的に変化するから

  • JAutodoc - Eclipse Plugin

    JAutodoc is an Eclipse Plugin for automatically adding Javadoc and file headers to your source code. It optionally generates initial comments from element name by using Velocity templates for Javadoc and file headers. Features JAutodoc has the following features: Mode Complete existing Javadoc Existing Javadoc will not be touched. Only missing tags will be added and so far undocumented elements wi

  • 1