Ajouter des commentaires au code Java - dummies

Cette liste Java a une version améliorée d'un exemple de programme. En plus de tous les mots-clés, les identificateurs et la ponctuation, il contient du texte destiné à être lu par les êtres humains.

/ * * Listing 3-6 dans "Java For Dummies, 6th Edition" * * Copyright 2014 Wiley Publishing, Inc. * Tous droits réservés. * / / ** * La classe Displayer affiche le texte * sur l'écran de l'ordinateur. * * @author Barry Burd * @version 1. 0 10/24/13 * @voir java. lang. System * / public class Displayer {/ ** * La méthode principale est où * l'exécution du code commence. * * @param args (Voir le chapitre 11.) * / public static void principal (String args []) {System. en dehors. println ("J'aime Java!"); //JE? Vous?}}

Un commentaire est une section spéciale de texte dans un programme dont le but est d'aider les gens à comprendre le programme. Un commentaire fait partie de la documentation d'un bon programme.

Le langage de programmation Java a trois types de commentaires:

• Commentaires traditionnels: Les cinq premières lignes de la liste forment un commentaire traditionnel . Le commentaire commence par / * et se termine par * /. Tout entre l'ouverture / * et la fermeture * / est pour les yeux humains seulement. Aucune information sur "Java For Dummies, 6th Edition" ou Wiley Publishing, Inc. n'est traduite par le compilateur.

  Les deuxième, troisième, quatrième et cinquième lignes du Listing 3-6 ont des astérisques supplémentaires (*). Ils sont appelés extra parce que ces astérisques ne sont pas requis lorsque vous créez un commentaire. Ils rendent juste le commentaire joli.

• Commentaires de fin de ligne: Le texte // I? Toi? dans la liste, un commentaire de fin de ligne . Un commentaire de fin de ligne commence par deux barres obliques et va jusqu'à la fin d'une ligne de type. Encore une fois, le compilateur ne traduit pas le texte dans le commentaire de fin de ligne.

• Commentaires Javadoc: Un commentaire javadoc commence par une barre oblique et deux astérisques (/ **). La liste a deux commentaires javadoc - un avec le texte La classe Displayer … et un autre avec le texte La méthode principale est où ….

  Un commentaire javadoc est un type particulier de commentaire traditionnel. Un commentaire javadoc est destiné à être lu par des personnes qui ne regardent même pas le code Java. Mais cela n'a pas de sens. Comment pouvez-vous voir les commentaires de javadoc?

  Eh bien, un certain programme appelé javadoc (quoi d'autre?) Peut trouver tous les commentaires de javadoc dans la liste et transformer ces commentaires en une belle page web. Cette figure montre la page.

  

Les commentaires Javadoc sont super. Voici plusieurs grandes choses à leur sujet:

• La seule personne qui doit regarder un morceau de code Java est le programmeur qui écrit le code.Les autres personnes qui utilisent le code peuvent découvrir ce que fait le code en visualisant la page Web générée automatiquement.

• Comme les autres personnes ne regardent pas le code Java, les autres personnes n'apportent aucune modification au code Java. (En d'autres termes, les autres personnes n'introduisent pas d'erreurs dans le code Java existant.)

• Parce que les autres ne regardent pas le code Java, les autres n'ont pas à déchiffrer les rouages ​​internes du code Java. Tous ces gens ont besoin de savoir sur le code est ce qu'ils lisent sur la page Web du code.

• Le programmeur ne crée pas deux choses séparées - du code Java ici et de la documentation sur le code là-bas. Au lieu de cela, le programmeur crée un morceau de code Java et intègre la documentation (sous la forme de commentaires javadoc) directement dans le code.

• Mieux encore, la génération de pages Web à partir de commentaires javadoc est automatique. Donc la documentation de tout le monde a le même format. Quel que soit le code Java que vous utilisez, vous trouverez des informations sur ce code en lisant une page comme celle de la figure. C'est bien parce que le format est familier à quiconque utilise Java.