Javadoc @since Tag Management

API-tools bieden ondersteuning voor het beheer van Javadoc-tags @since op nieuwe elementen die zijn toegevoegd aan de API (typen, methoden, velden etc). Nieuwe API-elementen kunnen zijn: een nieuw type toegevoegd aan een API-pakket, een nieuw type toegevoegd aan een API-type, een nieuwe methode toegevoegd aan een API-type of een nieuw veld toegevoegd aan een API-type. Methoden toevoegen is een bijzonder geval, waarbij methoden toevoegen kan inhouden: een methode toevoegen aan een type, een bovenliggende klassemethode uitschakelen, een bovenliggende interfacemethode implementeren of een handtekening van een bestaande methode wijzigen.

Opmerking: taggegevens van @since worden niet doorgegeven via implementatie of het maken van subklassen. Van elk element dat is toegevoegd aan de API wordt verwacht dat dit een eigen @since-tag en versiegegevens heeft.

De tool biedt de volgende validatie voor @since-tags:

De voorkeuren voor tagbeheer van @since kunnen worden gewijzigd op de voorkeurenpagina Voorkeurenpagina voor console openen Pluginontwikkeling > API-fouten/waarschuwingen.

@since-tags ontbreken

Elk nieuw API-element dat wordt vastgesteld, wordt gecontroleerd door de tool om ervoor te zorgen dat dit element een @since-tag heeft. Als het nieuwe element geen @since-tag heeft wordt aangegeven dat deze een tag vereist, en wordt een versie voor de tag voorgesteld. De voorgestelde versie voor de nieuwe tag is de huidige versie van de bundel - behalve in het geval van een API-wijziging waardoor programma's niet meer werken, waar de bundelversie ook moet worden bijgewerkt. Als de bundelversie ook moet worden bijgewerkt is de voorgestelde versie voor de ontbrekende @since-tag degene van de voorgestelde bundelversie.

Kijkt u naar het volgende voorbeeld: u hebt een bundel A met versie 1.0.0 en een klasse C die is toegevoegd in versie 1.1.0 van A die methode m1() bevat.

Indeling @since-tags onjuist

In nieuwe elementen kunnen @since-tags worden gecontroleerd op consistentie om ervoor te zorgen dat ze juist zijn geformuleerd. API-tools controleert dat alle @since-tags de volgende algemene indeling volgen:

[@since] [pre-amble] [2 part version] [post-amble]

Bekijk de volgende voorbeelden van @since-tags:

Ongeldige versies @since-tag

In nieuwe elementen kunnen @since-tags ook worden gecontroleerd op geldigheid. Een @since-tag wordt beschouwd als geldig als de versiegegevens in de tag overeenkomen met de versie van de bundel.

bekijk het volgende voorbeeld waar we een nieuwe methode m2() hebben toegevoegd aan een API-klasse in bundel A, waarvan de versie 1.0.0 is:

Verwante taken
Instellen van een basislijn

Verwant onverwerp
API-basislijnvoorkeuren
Voorkeuren voor API-fouten en -waarschuwingen