Az API eszközök támogatja a @since Javadoc címkék
kezelését az API-hoz hozzáadott új elemekhez (típusok, metódusok, mezők,
és így tovább).
Az új API elemek a következők lehetnek: egy API csomaghoz hozzáadott
új típus, egy API típushoz hozzáadott új típus, egy API típushoz
hozzáadott új metódus vagy egy API típushoz hozzáadott új mező.
A metódus hozzáadása egy speciális eset: egy metódus hozzáadása
történhet metódus hozzáadásával egy típushoz, egy szülőosztályban lévő
metódus újradefiniálásával, egy szülőfelület metódusának
megvalósításával vagy egy meglévő metódus szignatúrájának
módosításával.
Megjegyzés: a @since címke információi nem megvalósításon
vagy származtatáson keresztül vannak terjesztve. Az API-hoz hozzáadott
minden elemnek rendelkeznie kell egy saját @since címkével
és verzió információkkal.
Az eszközkészlet a következő érvényesítést biztosítja a
@since címkékhez:
A @since címke kezelési beállításai a
Bedolgozó fejlesztés > API hibák/figyelmeztetések beállítási
oldalon adhatók meg.
Az eszközkészlet minden észlelt új API elemet ellenőriz, hogy
rendelkezik-e @since címkével.
Ha az új elemnek nincs @since címkéje, akkor megjelöli
olyan elemként, amelynek szüksége van egy ilyen címkére, és javaslatot
tesz a verziószámra.
Az új címkéhez javasolt verziószám a köteg aktuális verziószáma lesz -
kivéve egy törést okozó API módosítás esetén, amikor a köteg verziószámát
ugyancsak frissíteni kell. Ha a köteg verziószámát is frissíteni kell,
akkor a hiányzó @since címke javasolt verziószáma a
köteg javasolt verziószámával fog megegyezni.
Tekintse a következő példát: van egy A köteg, melynek verziószáma 1.0.0 és van egy C osztály, amely az A köteg 1.1.0 változatában lett hozzáadva. Ez tartalmazza az m1() metódust.
@since címke problémát fog
jelenteni az m2() metódushoz és javasolja egy új @since 1.1
címke elhelyezését az m2() metódushoz.@since címke
problémát jelent az m2() metódushoz és javasolja egy új @since
2.0 címke elhelyezését az m2() metódushoz. A 2.0.0 a köteg új javasolt
verziószáma.
Az új elemek @since címkéjének konzisztenciája ellenőrizve lesz
a megfelelő formátum biztosítása érdekében. Az API eszközkészlet
ellenőrzi, hogy az összes @since címke általános formátuma a
következő legyen:
[@since] [bevezetés] [2 részből álló verziószám] [lezárás]
Figyelje meg a következő @since címke példákat:
@since A 1 m2() hozzáadva: rosszul formázottként lesz megjelölve, mivel a verziószámból hiányzik a második szegmens@since: rosszul formázottként lesz megjelölve, mivel nincs megadva a verziószám@since A: meg lesz jelölve, mivel nincs megadva a verziószám@since 1.0.0: meg lesz jelölve, mivel a verziószám túl sok részből áll@since A 1.0 m2() hozzáadva: nem lesz megjelölve
Az új elemek esetén az eszközkészlet ugyancsak ellenőrzi a @since címke érvényességét. Egy @since címke akkor tekinthető érvényesnek, ha a címkében
lévő verziószám megfelel a köteg verziószámának.
Figyelje meg a következő példát, ahol hozzáadtunk egy új m2() metódust egy API osztályhoz, amely az 1.0.0 verziószámú A kötegben található:
@since A 1.0 m2() metódus hozzáadva: érvényesnek számít@since A 2.0 m2() metódus hozzáadva: érvénytelen, mivel az A köteg verziószáma 1.0.0@since A 0.1 m2() metódus hozzáadva: érvénytelen, mivel az A köteg verziószáma 1.0.0

API alapsor beállítások
API hibák és figyelmeztetések beállításai