Java: la création de nouvelles annotations

category Ordinateurs et logiciels / Programmation / Java

Vous avez vu les commentaires utilisés dans de nombreux exemples de code Java. Le compilateur ignore les commentaires, donc quand vous créez un commentaire vous pouvez écrire ce que vous vous sentez sera utile plus tard dans déterminer ce que l'application peut faire. Commentaires documenter votre code.

Cependant, il ya un autre type de documentation - l'annotation. Une annotation est une sorte de documentation qui comprend également le compilateur. Quand le compilateur voit annotation dans votre code, il sait qu'il a besoin de faire quelque chose de spécial avec le code qui suit. Annotations sont utiles pour documenter votre code d'une manière fonctionnelle afin que le compilateur peut aider à faire respecter ce que la documentation que vous fournissez.

L'ensemble des annotations prédéfinies qui viennent avec Java sont relativement limitées en usage. Pour créer des annotations vraiment utiles, il faut les concevoir vous-même ou les faire dans le cadre d'un paquet tiers. Création d'une nouvelle annotation est un processus en trois étapes:

  1. Ajoutez l'instruction d'importation approprié:




    importer java.lang.annotation *. -

  2. Définir une interface qui décrit l'annotation au compilateur:

    . // Création d'une description d'annotation @ documentée interface @ AuthorData {Nom String () - Chaîne Date () - version double () par défaut 1.0-}

    Dans ce cas, l'annotation apparaîtra dans la documentation créée par Javadoc car il inclut l'annotationDocumented. Chaque description de l'annotation commence avec le mot-cléinterface suivie par le nom du type d'annotation, qui est AuthorData dans ce cas.

    Dans les accolades, vous voyez les champs utilisés pour définir les données d'annotation. Cet exemple inclut le nom, la date et la version. Le mot-clé par défaut fournit une valeur pour un champ particulier. Cela signifie que le champ utilise la valeur si elle n'a pas été définie comme étant une partie de l'annotation dans la demande.

  3. Utilisez l'annotation dans l'application:

    AuthorData (Name = "John Smythe", date = "01/04/2014")

    L'annotation apparaît avant que l'élément qu'il affecte, comme une déclaration de classe. Vous devez définir chaque champ qui n'a pas de valeur par défaut. En option, vous définissez également les champs qui ne ont une valeur par défaut. Dans ce cas, le nom de l'auteur est John Smythe, et le code a été mis à jour le 01/04/2014.

Articles Similaires

A propos Auteur
Comment utiliser les commentaires en java Comment utiliser les commentaires en java

UN commentaire Java est un peu de texte qui fournit des explications de votre code. Le compilateur ignore les commentaires, vous pouvez donc placer le texte que vous voulez dans un commentaire. Utilisant beaucoup de commentaires dans vos programmes…

Comment utiliser les commentaires en java Progamming Comment utiliser les commentaires en java Progamming

Dans la programmation Java, il ya une différence entre le code écrit juste pour les machines et le code écrit pour être lu par les gens. Cette première liste est très simple et est destiné seulement pour les machines.package classe…

Comment utiliser des packages Java et les déclarations d'importation Comment utiliser des packages Java et les déclarations d'importation

En Java, vous pouvez regrouper un tas de classes dans ce qu'on appelle un package. En fait, les classes API standard de Java sont divisés en environ 200 paquets. Ici, vous pouvez vérifier les paquets nommés java.util, java.lang, et java.io.Le…

Comment utiliser javadoc pour documenter vos classes Comment utiliser javadoc pour documenter vos classes

Une étape reste avant que vous pouvez rendre publique votre bibliothèque de classe nouvelle chaude ou de l'application: la préparation de la documentation pour ses classes. Heureusement, Java fournit un outil appelé JavaDoc qui peut…

Comment utiliser les expressions lambda en java 8 Comment utiliser les expressions lambda en java 8

Java 8 introduit une nouvelle fonctionnalité qui à certains égards est similaire aux classes anonymes, mais avec une syntaxe plus concise. Plus spécifiquement, une expression lambda vous permet de créer une classe anonyme qui implémente un…

Java: en utilisant les annotations prédéfinies Java: en utilisant les annotations prédéfinies

Les types et le contenu des annotations en Java, comme les commentaires, ne sont limitées que par votre imagination. Oui, Java fournit quelques annotations prédéfinies, mais vous pouvez aussi créer des annotations qui décrivent les éléments…

Forfaits et déclarations d'importation en java Forfaits et déclarations d'importation en java

Java dispose d'une fonctionnalité qui vous permet forfaitaire classes dans des groupes de classes. Chaque forfaitaire de classes est appelé package. Dans le monde Java, les programmeurs ne donnent habituellement que ces paquets noms longs,…

Programmation Java: l'observation portée dans un bloc Programmation Java: l'observation portée dans un bloc

Les développeurs Java ont souvent des problèmes à comprendre pourquoi une application se comporte mal en cas de problème d'accès de bloc. La ligne directrice de base est que toute variable que vous créez dans un bloc est défini uniquement…

Les types de données de huit java Les types de données de huit java

Le terme Type de données se réfère au type de données qui peut être stockée dans une variable. Parfois, Java est appelé “ fortement typé Langue ” parce que quand vous déclarez une variable, vous devez spécifier le type de la…

Comment ajouter des symboles mathématiques dans MATLAB Comment ajouter des symboles mathématiques dans MATLAB

Vous souhaitez avoir un moment difficile à présenter des formules autres sans être en mesure d'utiliser les symboles mathématiques. MATLAB vous offre une multitude de symboles que vous pouvez utiliser à des fins de sortie. Voici les symboles…

Balisage et annoter des documents PDF créés par vos élèves Balisage et annoter des documents PDF créés par vos élèves

Si vos élèves de sauvegarder leur travail au format PDF, vous pouvez avoir besoin de balisage ou d'annoter les documents PDF avant de les retourner. PDF est souvent le format utilisé pour les formes, donc si votre ministère exige que vous ou vos…

Comment ajouter des annotations à une vidéo YouTube Comment ajouter des annotations à une vidéo YouTube

Lorsque vous publiez des vidéos sur YouTube, vous pouvez les faire travailler pour vous en ajoutant des annotations qui parlent directement à votre auditoire. Vous pouvez proposer téléspectateurs souscrivent à votre chaîne YouTube ou utiliser…

Xml pour les nuls Xml pour les nuls

En XML, un document valide doit être conforme aux règles de son (Document Type Definition) DTD ou le schéma, qui définit les éléments qui peuvent apparaître dans le document et comment les éléments peuvent nicher un dans l'autre. Si un…

Comment ajouter des annotations à vos vidéos de marketing sur youtube Comment ajouter des annotations à vos vidéos de marketing sur youtube

En plus de la fonctionnalité d'édition disponibles dans YouTube, il vous permet d'ajouter annotations à vos vidéos de marketing: Ces petites zones de texte ou des bulles dessinée de style fournissent des informations supplémentaires pour les…

» » » » Java: la création de nouvelles annotations