Javadoc-tunnisteen @since hallinta

Ohjelmointirajapintojen työkaluissa on ohjelmointirajapintaan lisättyjen uusien elementtien (esimerkiksi tyyppien, metodien ja kenttien) @since-Javadoc-tunnisteiden hallintatuki. Ohjelmointirajapinnan uudet elementit voivat olla ohjelmointirajapinnan pakettiin tai lajiin lisättyjä uusia lajeja tai ohjelmointirajapinnan lajiin lisättyjä uusia metodeja tai kenttiä. Metodin lisäykset ovat erityistapauksia, joissa metodin lisäys voi merkitä metodin lisäystä lajiin, pääluokan metodin ohitusta, päärajapinnan metodin toteutusta tai aiemmin luotujen metodien allekirjoituksen muutosta.

Huomautus: @since-tunnisteiden tietoja ei välitetä toteutusten tai aliluokkien kautta. Kullakin ohjelmointirajapintaan lisättävällä elementillä oletetaan olevan omat @since-tunnisteensa ja versiotietonsa.

Työkalut sisältävät seuraavat @since-tunnisteiden tarkistukset:

@since-tunnisteiden hallinnan oletusasetuksia voi muuttaa Avaa konsolin oletusasetussivun Lisäosien kehitys > Ohjelmointirajapinnan virheet/varoitukset -oletusasetussivulla.

Puuttuvat @since-tunnisteet

Työkalut tarkistavat, onko jokaisessa uudessa havaitussa ohjelmointirajapinnan elementissä @since-tunniste. Jos elementissä ei ole @since-tunnistetta, elementtiin lisätään määrite @since-tunnisteen tarpeesta. Järjestelmä ehdottaa lisäksi tunnisteelle versiota. Uuden tunnisteen ehdotettu versio on resurssijoukon nykyinen versio, paitsi jos kyseessä on rikkova ohjelmointirajapinnan muutos, jolloin myös resurssijoukon versio on päivitettävä. Jos myös resurssijoukon versio on päivitettävä, puuttuvan @since-tunnisteen ehdotettu versio on sama kuin resurssijoukon ehdotettu versio.

Tutustu seuraavaan esimerkkiin: järjestelmässä on resurssijoukko A, jonka versio on 1.0.0, ja luokka C, joka on lisätty resurssijoukon A versioon 1.1.0. Kyseinen versio sisältää metodin m1().

Virheellisesti muotoillut @since-tunnisteet

Uusien elementtien @since-tunnisteiden ristiriidattomuus voidaan tarkistaa, jolloin varmistetaan, että tunnisteet on muotoiltu oikein. Ohjelmointirajapinnan työkalut tarkistavat, että kaikki @since-tunnisteet noudattavat seuraavaa yleistä muotoilua:

[@since] [johdanto] [kaksiosainen versio] [jälkiliite]

Tutustu seuraaviin @since-tunniste-esimerkkeihin:

Virheelliset @since-tunnisteen versiot

Myös uusien elementtien @since-tunnisteiden kelpoisuus voidaan tarkistaa. @since-tunnistetta pidetään kelvollisena, jos tunnisteen versiotiedot vastaavat resurssijoukon versiota.

Tutustu seuraavaan esimerkkiin. Esimerkissä on lisätty uusi metodi m2() ohjelmointirajapinnan luokkaan, joka sijaitsee resurssijoukossa A, jonka versio on 1.0.0:

Aiheeseen liittyviä tehtäviä
Perustason määritys

Aiheeseen liittyviä ohjeita
Ohjelmointirajapintojen perustasojen oletusasetukset
Ohjelmointirajapintojen virheiden ja varoitusten oletusasetukset