Format:Javadoc:SE
Documentație format
Această documentație este adusă de la pagina Format:Javadoc:SE/doc.
|
[lectură]
[modificare]
[istoric] |
Utilizează Lua: |
Format pentru crearea unei legături externe către Javadocul pentru o clasă în versiunea actuală de API Java SE. Acest format trebuie folosit în locul unui URL explicit pentru a permite actualizarea automată a tuturor linkurilor la cel mai recent API doar prin modificarea formatului.
Actualizați variabila homeURLs
din antetul modulului Modul:Javadoc pentru a actualiza versiunea de Java către care trimite linkul.
Utilizare
Acestea sunt utilizările comune ale formatului:
Introduceți aceasta pentru a obține aceasta {{Javadoc:SE}}
Java SE 19 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()
{{Javadoc:SE|jdk/javadoc/doclet|StandardDoclet|module=jdk.javadoc}}
StandardDoclet
În exemplul de mai sus, clone()
poate fi orice membru documentat în Javadoc care nu este o clasă sau o interfață. De exemplu, {{Javadoc:SE|java/lang|System|out}}
produce System.out
. Pentru un membru care este clasă sau interfață, se specifică la numele clasei OuterClass.InnerClass
, astfel încât {{Javadoc:SE|java/lang|Character.Subset}}
produce Character.Subset
.
URL-urile Javadoc nu includ tipurile parametrizate generice. Pentru a afișa parametrii tipuri, specificați un parametru class
și/sau member
la format pentru a suprascrie numele clasei afișate și/sau numele membrului. Notația cu tipuri parametrizate folosește paranteze unghiulare (<
și >
), deci numele de tipuri care corespund tagurilor HTML trebuie să folosească codificări ale caracterelor <
pentru <
și >
pentru >
.
Scrieți aceasta Pentru a obține aceasta {{Javadoc:SE|class=Class<T>|java/lang|Class}}
Class<T>
{{Javadoc:SE|class=Class<T>|
member=asSubclass(Class<U>)|
java/lang|Class|asSubclass(java.lang.Class)}}Class<T>.asSubclass(Class<U>)
{{Javadoc:SE|package=java.lang|class=Class<T>|
java/lang|Class}}java.lang.Class<T>
{{Javadoc:SE|package=java.lang|class=Class<T>|
member=asSubclass(Class<U>)|
java/lang|Class|asSubclass(java.lang.Class)}}java.lang.Class<T>.asSubclass(Class<U>)
URL-ul către o metodă folosește numele fully-qualified al tipurilor parametrizate. Parametrul member
poate fi folosit numele simplu al tipului parametrilor metodei, așa cum apare în tabelul anterior, sau chiar pentru a elimina parametrii cu totul.
În fine, dacă nu funcționează niciuna dintre acestea pentru textul afișat, furnizarea unui parametru name
permite suprascrierea integrală a numelui afișat pentru pachet/clasă/membru. (Parametrul name
nu va suprascrie textul însă atunci când se folosește forma {{Javadoc:SE}}
.)