Rendant Sense of Java Documentation API - mannequins

Il était une fois, les gens ont jugé les langages de programmation (y compris Java) uniquement par leurs caractéristiques grammaticales. Est-ce qu'une instruction if fait ce que vous attendez de lui? Les instructions de bouclage sont-elles faciles à utiliser? Les méthodes sont-elles mises en œuvre efficacement?

De nos jours, les choses sont un peu différentes. Java a toute une collection de fonctionnalités grammaticales, mais Java est bien plus qu'un simple ensemble de règles de grammaire. Java a une Appl interface de programmation standard - une énorme bibliothèque comprenant plus de 4 000 classes, chacune avec sa propre fonctionnalité, ses propres limites et ses propres règles pour une utilisation efficace.

Recherche d'un terme

Vous pouvez trouver des éléments dans la documentation de l'API de différentes façons. Chaque façon est pratique dans une situation ou une autre. Par exemple, Java a une méthode nommée System. en dehors. println. Ce qui suit décrit deux façons de rechercher le système. en dehors. Méthode println

Utiliser l'index

Voici comment trouver quelque chose, tel que Système. en dehors. println, en utilisant l'index:

Consulter les docs. oracle. com / javase / 8 / docs / api /.
Cliquez sur le lien INDEX en haut de la page pour ouvrir l'index, comme indiqué dans la Figure 1.

Figure 1: La page principale de la documentation de l'API.
Une liste de lettres est proche du haut de l'index (voir Figure 2). Cliquez sur le lien P pour aller à la section avec println dedans.

">
Figure 2: La page d'index de la documentation de l'API.
Dans la section P, recherchez println pour trouver les entrées imprimées.

La plupart des navigateurs Web vous permettent de rechercher quelque chose comme println dans le texte d'une page. Voici comment:
1. Assurez-vous que le navigateur sait que vous voulez effectuer une recherche dans le grand cadre qui occupe la majeure partie de la page (et non dans les petits cadres sur le côté gauche de la page). Pour ce faire, cliquez sur votre souris dans le grand cadre. (Ne cliquez pas sur un lien Cliquez sur une zone blanche neutre du cadre.)
2. Ouvrez la boîte de dialogue de recherche du navigateur. Sur la plupart des navigateurs Windows, appuyer sur Ctrl + F permet de masquer la boîte de dialogue Rechercher. Sur un Mac, cliquer Command + F fait l'affaire.
3. Lorsque la boîte de dialogue Rechercher apparaît, tapez println dans la zone de texte, puis cliquez sur le bouton Rechercher ou Suivant de la boîte.
Choisissez l'une des entrées println.

La section P a un grand nombre d'entrées println, comme le montre la figure 3 ci-dessous. Les entrées diffèrent les unes des autres de deux façons:
- Chaque entrée indique println (int), println (String) ou println (someOtherTypeName). Le nom du type peut différer d'une entrée à l'autre.
- Chaque entrée dit que println est une méthode de la classe java. someStuff. someMoreStuff . La classe peut différer d'une entrée à l'autre.
  
  println dans l'index de la documentation de l'API. ">
  Figure 3: Quelques entrées println dans l'index de la documentation de l'API.
À ce stade, il vaut mieux fouiller. Si vous essayez d'imprimer quelque chose comme "Bonjour tout le monde! ", Vous voulez une des entrées println (String). D'un autre côté, si vous essayez d'imprimer la valeur de lengthOfStraightLine, vous choisirez probablement une entrée println (double).

Supposons maintenant que vous avez choisi println (String). Vous pouvez choisir parmi trois entrées println (String). On dit que c'est une méthode en classe Java. io. PrintStream, le suivant est une méthode dans la classe java. io. PrintWriter, et le troisième est une méthode dans la classe java. sql. DriverManager. Laquelle de ces trois entrées choisissez-vous?

Eh bien, ce que vous essayez vraiment d'appeler est quelque chose qui s'appelle System. en dehors. println. Si vous passez par l'ensemble de la recherche avec Systemout, vous trouverez ce système. out a le type PrintStream. (Voir la figure 4, ci-dessous.) Ainsi, l'entrée println (String) que vous décidez de choisir est

println (String) - Method dans la classe java. io. PrintStream. La variable

out a le type PrintStream. ">
Figure 4: La variable out a le type PrintStream.
Cliquez sur le lien correspondant à l'entrée que vous avez choisie.

Lorsque vous cliquez sur le lien println (Chaîne), le navigateur vous dirige vers une page expliquant une méthode println, comme illustré à la Figure 5. La page indique ce que println fait ("Imprimer une chaîne, puis …") et pointe vers d'autres pages utiles, comme la page avec la documentation pour String.

méthode println. ">
Figure 5: Une description de la méthode println.

Utiliser la liste des classes

Voici comment trouver une entrée dans l'API en commençant par la liste des classes:

Consulter les documents. oracle. com / javase / 8 / docs / api /.
Recherchez la page qui documente la classe System.

Vous recherchez une documentation qui explique System. en dehors. println. Donc, vous cherchez System, travaillez votre chemin à l'extérieur, et à partir de là, travaillez votre chemin à println.

Pour trouver un lien vers Système, regardez dans le cadre inférieur sur le côté gauche de la page. (Voir Figure 6.) Pour des conseils sur la recherche de texte sur la page, reportez-vous à l'étape 3 de la section "Utilisation de l'index".

Classe système. ">
Figure 6: Recherche d'un lien vers la classe System.
Cliquez sur le lien Système pour que votre navigateur affiche la page de documentation de la classe System, comme indiqué dans la Figure 7.

Documentation de la classe System. ">
Figure 7: La documentation de la classe System.
Sur la page de documentation de la classe System, recherchez la variable out.

Si vous utilisez la boîte de dialogue Rechercher de votre navigateur Web, vous devez cliquer plusieurs fois sur le bouton Suivant. (Le nom est si courant qu'il apparaît plusieurs fois dans plusieurs contextes différents sur la page Documentation du système.) Lorsque vous avez trouvé ce que vous cherchez, vous voyez une table comme celle illustrée à la figure 4 ci-dessus.
Dans la ligne de sortie du tableau, cliquez sur le lien PrintStream.

Selon la documentation, la variable out fait référence à un objet de type PrintStream.Cela signifie que println fait partie de la classe PrintStream. C'est pourquoi vous cliquez sur le lien PrintStream.
Sur la page de documentation de PrintStream, recherchez println (String).

Vous voyez une explication semblable à celle illustrée à la figure 5 ci-dessus.

Vous pouvez le faire, aussi

Après avoir suivi les étapes de cet article, vous pourriez être tenté de dire: «Bon marché! Je peux trouver println dans les documents de l'API, mais je ne trouve probablement rien d'autre. Et si les gens créent de la documentation pour des choses qu'ils programment eux-mêmes, alors leur documentation ne ressemblera pas à la documentation standard de l'API. Je serai dans une crique. "

La réponse appropriée à une telle objection est" Non-sens! Balivernes! Balivernes! Plumes de cheval! "Voici pourquoi:

La plupart des astuces dont vous avez besoin pour trouver des éléments dans la documentation Java standard sont illustrées dans les instructions pas à pas de cet article. Si vous pouvez trouver le système. en dehors. println, vous pouvez également trouver javax. balançoire. JButton ou l'un des 4 200 programmes de l'API Java standard.

Et, à mesure que vous en apprendrez plus sur Java et les relations entre les classes, les méthodes et les variables, les instructions étape par étape de cet article vous sembleront beaucoup plus naturelles.
Pour lire la documentation d'autres personnes, vous pouvez supprimer ce problème directement de votre liste. Les documents d'API standard n'ont pas été tapés à la main. Ils ont été générés automatiquement à partir du code de programme Java réel. Par exemple, le code pour PrintStream. java a quelques lignes qui ressemblent à ceci:
```
/ ** * Imprime une chaîne puis termine la ligne. * Cette méthode se comporte comme si elle invoquait *

{@ link #print (String)}

* puis

{@ link #println ()}

. * * @param x La

chaîne

à imprimer. * /
```
Pour créer la documentation API, les capitaines de Java ont exécuté un programme appelé javadoc . Le programme javadoc a pris des lignes comme celles-ci à partir du PrintStream. fichier java et utilisé les lignes pour faire la documentation que vous voyez dans votre navigateur Web.

D'autres programmeurs Java font la même chose. En fait, tous ceux qui écrivent du code Java utilisent le programme javadoc pour générer de la documentation. Donc, la documentation Java de tout le monde ressemble à la documentation Java de tout le monde. Lorsque vous savez comment lire la documentation standard de l'API, vous savez comment lire les documents Java d'origine.

Et oui, vous pouvez utiliser le programme javadoc pour créer votre propre documentation. Lorsque vous téléchargez le JDK, vous obtenez le programme javadoc dans le cadre de l'accord.