Gestion des balises @since Javadoc

Les outils d'API fournissent le support de gestion des balises @since Javadoc dans les nouveaux éléments ajoutés à l'API (types, méthodes, zones, etc). Les nouveaux éléments d'API peuvent correspondre à un nouveau type ajouté à un package d'API, un nouveau type ajouté à un type d'API, une nouvelle méthode ajoutée à un type d'API ou une nouvelle zone ajoutée à un type d'API. L'ajout d'une méthode est un cas spécial dans lequel un ajout de méthode peut correspondre à l'ajout d'une méthode à un type, au remplacement d'une méthode de classe parent, à l'implémentation d'une méthode d'interface parent ou à la modification d'une signature de méthode existante.

Remarque : les informations de balise @since ne sont pas propagées via l'implémentation ou la sous-classification. Chaque élément ajouté à l'API est supposé avoir sa propre balise @since et ses propres informations de version.

Les outils fournissent la validation suivante pour les balises @since :

Vous pouvez modifier les préférences de gestion des balises @since dans la page des préférences Ouvre la page des préférences de console Développement de plug-in > Erreurs/Avertissements d'API.

Balises @since manquantes

Chaque nouvel élément d'API détecté est vérifié par les outils pour déterminer s'il dispose d'une balise @since. Si le nouvel élément ne dispose pas d'une balise @since, il est marqué comme tel et une version de la balise est proposée. La version proposée pour la nouvelle balise est la version en cours du regroupement, sauf dans le cas d'une modification générant une rupture d'API où il est nécessaire de mettre à jour la version. Si la version du regroupement doit être mise à jour également, la version proposée pour la balise @since manquante correspond à la version de regroupement proposée.

Voici un exemple : vous disposez d'un regroupement A avec la version 1.0.0 et d'une classe C qui a été ajoutée à la version 1.1.0 de A qui contient la méthode m1().

Balises @since incorrectes

La cohérence des balises @since des nouveaux éléments peut être vérifiée pour déterminer si les balises sont correctes. Les outils d'API vérifient que toutes les balises @since respectent le format général suivant :

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

Voici des exemples de balise @since :

Versions de balise @since non valides

Vous pouvez également vérifier la validité des balises @since des nouveaux éléments. Une balise @since est considérée valide si les informations de version dans la balise correspondent à la version du regroupement.

Voici des exemples dans lesquels nous avons ajouté une nouvelle méthode m2() à une classe d'API dans le regroupement A, version 1.0.0 :

Tâches connexes
Configuration d'une référence

Référence associée
Préférences de référence d'API
Préférences Erreurs/Avertissements d'API