Chapter 14 Travailler avec Java

Définition de valeurs pour les étiquettes Javadoc

Vous pouvez définir des valeurs pour les étiquettes Javadoc à partir de la page Attributs étendus de la feuille de propriétés d'un objet.

Pour ce faire, vous devez sélectionner une étiquette Javadoc dans la liste des attributs étendus, puis cliquer sur le bouton Points de suspension dans la Colonne Valeur. La boîte de dialogue de saisie qui s'affiche vous permet de créer des valeurs pour l'étiquette Javadoc sélectionnée. Par exemple, si le type de données a pour valeur (Color), vous pouvez sélectionner une autre couleur dans la boîte de dialogue Couleur en cliquant sur le bouton Points de suspension dans la colonne valeur.

Remarque : vous définissez des valeurs pour les commentaires @return, @exception, @throws, @serialData, @serialField, @serial JavaDoc et @param dans l'attribut étendu Javadoc@misc.

Aucune étiquette Javadoc n'est générée si vous ne spécifiez pas de valeur pour les attributs étendus.

N'oubliez pas de répéter l'étiquette Javadoc avant chaque nouvelle valeur, certaines valeurs pouvant comporter plusieurs lignes. Si vous ne répétez pas l'étiquette, les valeurs ne seront pas générées.

Lorsque vous affectez une valeur à une étiquette Javadoc, l'étiquette et sa valeur s'affichent dans la page d'aperçu du code de l'objet.

@author

@author n'est pas généré si l'attribut étendu n'a aucune valeur.

@exceptions et @throws

@exceptions et @throws sont des étiquettes Javadoc synonymes utilisées pour définir les exceptions qui peuvent être provoquées par une opération.

Pour utiliser ces étiquettes, procédez comme suit :

• Dans la feuille de propriétés de l'opération, cliquez sur l'onglet Mise en oeuvre, puis sur l'onglet Exceptions pour afficher la page Exceptions. Vous pouvez saisir des exceptions dans cette page.
  
• Dans la même feuille de propriétés, cliquez sur l'onglet Attributs étendus, sélectionnez la ligne Javadoc@exception dans la liste, puis cliquez sur le bouton Points de suspension dans la colonne Valeur. Saisissez des valeurs pour chaque exception déclarée, sans oublier de répéter @exception ou @throws pour chaque exception.
  

Toutefois, il est également possible de saisir des valeurs directement après les étiquettes @exception ou @throws dans la page Attributs étendus. Ces commentaires décrivent les exceptions qui ne sont pas répertoriées dans les exceptions d'opération, et qui ne sont pas affichées après le paramètre throws dans la page d'aperçu du code de la classe.

Lorsque vous affichez un aperçu du code généré, chaque exception s'affiche avec sa valeur :

Copyright (C) 2005. Sybase Inc. All rights reserved.