最終更新:2013-02-13 (水) 16:20:07 (4386d)
Javadoc
Top / Javadoc
http://docs.oracle.com/javase/jp/6/technotes/tools/solaris/javadoc.html#javadoctags
書き方
/** * Returns an Image object that can then be painted on the screen. * The url argument must specify an absolute {@link URL}. The name * argument is a specifier that is relative to the url argument. * <p> * This method always returns immediately, whether or not the * image exists. When this applet attempts to draw the image on * the screen, the data will be loaded. The graphics primitives * that draw the image will incrementally paint on the screen. * * @param url an absolute URL giving the base location of the image * @param name the location of the image, relative to the url argument * @return the image at the specified URL * @see Image */ public Image getImage(URL url, String name) { try { return getImage(new URL(url, name)); } catch (MalformedURLException e) { return null; } }
タグ
タグ名 | バージョン | 使い方 | 内容 |
@author? | 1.0 | @author name-text | 開発者名を記述 |
{@code}? | 1.5 | {@code text} | <code>{@literal}</code> と同等です。 |
{@docRoot}? | 1.3 | {@docRoot} | 生成されたドキュメントのルートディレクトリを基点とする相対パスを表す |
@deprecated | 1.0 | @deprecated deprecated-text | 廃止されたクラス やメソッド |
@exception? | 1.0 | @exception class-name description | @throws?タグと同義 |
{@inheritDoc}? | 1.4 | {@inheritDoc} | もっとも近い継承可能なクラスまたは実装可能なインタフェースから、このタグの現在のドキュメンテーションコメントに、ドキュメントを継承 (コピー) |
{@link}? | 1.2 | {@link package.class#member label} | 表示テキスト label とのインラインリンクを挿入。 |
{@linkplain}? | 1.4 | {@linkplain package.class#member label} | リンクのラベルがコードフォントではなくプレーンテキストで表示される点以外は {@link} と同じ |
{@literal}? | 1.5 | {@literal text} | テキストを HTML マークアップまたは入れ子になった javadoc タグとして解釈せずに、text を表示 |
@param? | 1.0 | @param parameter-name description | メソッドの引数や総称型のパラメータ。引数名と引数の概要 |
@return? | 1.0 | @return description | メソッドの戻り値 |
@see | 1.0 | @see reference | 関連する他のメソッドまたはクラス、もしくはリンク |
@serial? | 1.2 | デフォルトで直列化可能フィールドのdocコメントで使用 | |
@serialData? | 1.2 | データの型と順序を直列化形式でドキュメント化 | |
@serialField? | 1.2 | SerializableクラスのObjectStreamField? コンポーネントをドキュメント化 | |
@since? | 1.1 | @since since-text | クラスまたはメソッドの導入されたバージョン |
@throws? | 1.2 | @throws class-name description | メソッドが投げる例外 |
{@value}? | 1.4 | {@value package.class#field} | |
@version? | 1.0 | @version version-text | クラスまたはメソッドのバージョン |