Template:Javadoc:SE/doc
 | これはTemplate:Javadoc:SEの解説サブページです。 使用方法、カテゴリ、およびその他テンプレート自体に含まれない情報を収容しています。 |
 | このテンプレートの記述は複雑な構成となっています。編集後の結果が予想できないか、または変更にともなう影響を修正する用意ができていない場合は編集をお控えください。練習や実験はテンプレートのサンドボックス・サブページ、テストケース・サブページもしくはあなた自身の利用者スペースのページでお願いします。 |
現在のバージョンのJava SE APIにあるクラスのJavadocへの外部リンクを作るテンプレートである。
このテンプレートは、更新されたときに最新のAPIが自動的に更新されるリンクを許可するURLの代わりとして使われるべきである。
使用方法
[編集]| 入力 | 出力 |
|---|---|
{{Javadoc:SE}} |
Java SE 9 API Javadocs |
{{Javadoc:SE|java/lang|Object}}
|
Object
|
{{Javadoc:SE|java/lang|Object|clone()}}
|
Object.clone()
|
{{Javadoc:SE|package=java.lang|java/lang}}
|
java.lang
|
{{Javadoc:SE|package=java.lang|java/lang|Object}}
|
java.lang.Object
|
{{Javadoc:SE|package=java.lang|java/lang|Object|clone()}}
|
java.lang.Object.clone()
|
上記の例として、clone()はクラスまたはインタフェースではないJavadocにドキュメントされたメンバにすることができる。それで、 {{Javadoc:SE|java/lang|System|out}} は System.outを生成する. クラスまたはインタフェースとして、クラス名は OuterClass.InnerClass。そして{{Javadoc:SE|java/lang|Character.Subset}}はCharacter.Subsetを生成する。
Javadoc URLはジェネリクスによってパラメタライズされた型を含まない。
表示したい型パラメータを得るには、表示されたクラス/メンバ名の名前をオーバーライドするためのテンプレートのクラスとメンバを確定する。パラメタライズされた型の表記は山括弧(<と>)であることに注意せよ。そしてHTMLのタグにマッチする名前の型パラメータ名は、<を&lt;に&gt;を>に文字実体参照される必要がある。
入力 出力 {{Javadoc:SE|class=Class<T>|java/lang|Class}}Class<T>{{Javadoc:SE|class=Class<T>|<br>member=asSubclass(Class&lt;U&gt;)|<br>java/lang|Class|asSubclass(java.lang.Class)}}Class<T>.asSubclass(Class<U>){{Javadoc:SE|package=java.lang|class=Class<T>|<br>java/lang|Class}}java.lang.Class<T>{{Javadoc:SE|package=java.lang|class=Class<T>|<br>member=asSubclass(Class&lt;U&gt;)|<br>java/lang|Class|asSubclass(java.lang.Class)}}java.lang.Class<T>.asSubclass(Class<U>)
メソッドのURLは引数の型にフルパス名を使用する。前表に示されるように、メンバパラメータはメソッド引数に簡易な型名を使用することができ、引数は完全に削除することもできる。
最終的に、表示テキストのための上記の働きのいずれであっても、nameパラメータの提供は、置き換えられたパッケージ/クラス/メンバ名表示によっては許容されない。(しかしながら、nameパラメータは{{Javadoc:SE}} 形式を使って表示されるテキストをオーバーライドしないだろう。)
入力 出力 {{Javadoc:SE|name=out|java/lang|System|out}}out
問題
[編集]- Javadocのいくつかのバージョンは、メンバの記述へのリンクとして使われるアンカータグの間に引数名とスペースを入れる J2SE 5.0 、 J2SE 1.4 として現在のJavadoc APIページを生成するために使われたものだった。残念なことに、それは、引数を二つ以上持つメソッドの外部リンクディレクトリインデックスが不可能であることを意味する。引数が二つ以上のメソッドへのリンクは、そのページのトップへのリンクとなるだろう。
メソッドの引数の型やコンストラクタのメンバ引数に角括弧([, ])を含むとテンプレートを破壊するようだ。そのかわりに、それらの数値実体参照で角括弧を[ と ]で置き換えるとこのようになる:
入力 出力 {{Javadoc:SE|java/util|Arrays|sort(java.lang.Object[])}}Arrays.sort(java.lang.Object[]){{Javadoc:SE | member=sort(Object[])|java/util|Arrays|sort(java.lang.Object[])}}Arrays.sort(Object[])
関連項目
[編集]- Template:Javadoc:SE-guide
- Template:Javadoc:EE - このテンプレート{{Javadoc:SE}}のJakarta EE版。
- Template:Javadoc:SE/Home URL - Javaのバージョンアップに伴いJavadocのURLが変更されたときはこのテンプレートの部品を更新する。