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 MyFirstJavaClass de org.allyourcode.myfirstproject public {/ ***param args static void main (String [] args) * / public {javax.swing.JOptionPane.showMessageDialog (null, "Bonjour") -}}

Cette deuxième liste a une version améliorée du code dans la première liste. En plus de tous les mots-clés, les identifiants, et la ponctuation, cette deuxième liste a le texte qui est destiné pour les êtres humains à lire.

/ ** Listing 5-2 * "Java pour les développeurs Android pour les nuls" ** auteur 2,013 Wiley Publishing, Inc. * Tous droits réservés. * /forfait org.allyourcode.myfirstproject-/ *** MyFirstJavaClass affiche une boîte de dialogue * sur l'écran de l'ordinateur. **author Barry Burd *version 1.0 02/02/13 * Lessee java.swing.JOptionPane * /public class MyFirstJavaClass { / *** Le point d'exécution de départ. ** *param Args (Non utilisé.) * /public static void main (String [] args) {javax.swing.JOptionPane.showMessageDialog (null, "Bonjour") - //nul?}}

UN commentaire est une section spéciale du texte à l'intérieur d'un programme dont le but est d'aider les gens à comprendre le programme. Un commentaire est une partie de la documentation d'un bon programme.

Le langage de programmation Java a trois sortes de commentaires:

• Commentaires traditionnels: Tout entre l'ouverture / * et la fermeture * / est seulement pour les yeux humains.

  Lignes 2-6 dans la deuxième liste des astérisques supplémentaires (*). Ils sont supplémentaire parce que ces astérisques ne sont pas nécessaires lorsque vous créez un commentaire. Ils ne font que le commentaire joli. Ils sont inclus dans la liste parce que, pour une raison quelconque, la plupart des programmeurs Java insistent sur l'ajout de ces astérisques supplémentaires.

• 
  
  
  
  

  Fin de ligne commentaires: Le texte //nul? dans la deuxième liste est une fin de ligne commentaire - il commence par deux barres obliques et va à la fin d'une ligne de texte. Une fois de plus, le compilateur ne traduit pas le texte à l'intérieur d'un commentaire de fin de ligne.

• Commentaires Javadoc: UN javadoc commentaire commence par une barre oblique et deux astérisques (/ **). La deuxième liste a deux commentaires Javadoc - l'un avec le texte MyFirstJavaClass affiche une boîte de dialogue. . . et un autre avec le texte Le point de départ. . . .

  UN javadoc commentaire est un type spécial de commentaire traditionnelle: Il est destiné à être lu par des gens qui ne regardent même le code Java.

  Attendez - qui n'a pas de sens. Comment pouvez-vous voir les commentaires Javadoc dans la liste si vous ne regarderez plus jamais la liste?

  Eh bien, avec quelques points et des clics, vous pouvez trouver tous les commentaires Javadoc dans la deuxième liste et les transformer en une page web de belle apparence, comme le montre la figure.

  

Pour rendre les pages de documentation pour votre propre code, suivez ces étapes:

1. Mettez commentaires Javadoc dans votre code.

2. Dans le menu principal dans Eclipse, choisissez Projet Générer Javadoc.

   En conséquence, la boîte de dialogue Javadoc Génération apparaît.

3. Dans la boîte de dialogue Javadoc Génération, sélectionnez le projet Eclipse dont le code que vous souhaitez documenter.

4. Toujours dans la boîte de dialogue Javadoc Génération, notez le nom du dossier dans le champ Destination.

   L'ordinateur met les pages de documentation nouvellement créés dans ce dossier. Si vous préférez un autre dossier, vous pouvez changer le nom du dossier dans ce champ Destination.

5. Cliquez sur Terminer.

   Par conséquent, l'ordinateur crée des pages de documentation.

Si vous visitez le dossier de destination et double-cliquez sur la nouvelle index.html l'icône de fichier, vous voyez vos belles (et instructifs) pages de documentation.

Vous pouvez trouver les pages de documentation pour les classes de l'API intégrées de Java en visitant Java SE la documentation du site Web d'Oracle à une page Regards. L'API de Java contient des milliers de classes, il ne faut pas mémoriser les noms des classes et de leurs méthodes. Au lieu de cela, vous visitez tout simplement ces pages de documentation en ligne.