Tutoriel JAVA N°5 : bonnes pratiques de développement avec Eclipse

Mettez en oeuvre les bonnes pratiques de développement dans l’environnement de développement d’Eclipse. Ayez les bons réflexes.

Aprés avoir mis en oeuvre les bonnes pratiques de développements vous apprendrez comment documenter son programme JAVA avec l’outil javadoc

ASTUCE —> Soyez informé de la mise à jour de nos tutos ou de la création de nouveaux tutos.

Prérequis

- Tutoriel Java N°4 : Installation Eclipse

Objectifs

- Mise en oeuvre des bonnes pratiques avec Eclipse

Programme

-  Partie 1 : utilisation de l’assistant de création de projet Java SE
-  Partie 2 : analyser les librairies du projet
-  Partie 3 : activer la vue ’console’
-  Partie 4 : utiliser de l’assistant création de classe
-  Partie 5 : numéroter des lignes de code
-  Partie 6 : identifier rapidement les méthodes d’une classe
-  Partie 7 : sauvegarder régulièrement votre travail
-  Partie 8 : identifier les taches AVANT de coder
-  Partie 9 : coder en utilisant l’indentation
-  Partie 10 : formater le code
-  Partie 11 : compiler avec Eclipse
-  Partie 12 : exécuter l’application sous Eclipse
-  Partie 13 : voir la javadoc dans Eclipse
-  Partie 14 : Ajouter la documentation des méthodes et de la classe
-  Partie 15 : voir la javadoc dans Eclipse
-  Partie 16 : Générer la javadoc de votre projet

Durée

- 60 min

Partie 1 : utilisation de l’assistant de création de projet Java SE

- A partir du Menu Eclipse, faire New/Java Project

New-java-project

L’écran suivant apparaît :Saisissez ’Bonjour’ comme nom de projet

New-java-project-1

QUESTION : expliquez 3 configurations sur cet écran

- Laissez les valeurs par défaut et cliquez sur le bouton Next

Nous avons alors cet écran

New-java-project-2

QUESTION : Où seront déposés les fichiers .class issus de la compilation ?

- Cliquez sur le bouton ’Finish’

L’écran suivant apparaît :

projet-bonjour

- Expliquez le rôle de l’icone ’src’

Partie 2 : analyser les librairies du projet

- Analysez le contenu ’JRE System Library’

projet-bonjour-1

QUESTION : D’où viennent tous ces Jars ?

- Analysez le contenu en particulier du jar ’rt.jar’
- Identifiez le package ’javax.swing’ dans ce jar

projet-bonjour-javax-swing

- Dans le package javax.swing , identifiez le fichier JFrame.class

projet-bonjour-JFrame

Nous allons maintenant créer la classe principale de l’application , celle possédant la méthode main()

Partie 3 : activer la vue ’console’

Ajoutez la vue ’console’ qui permettra d’avoir l’affichage , comme sur MS-DOS

projet-bonjour-console

La vue ’console’ apparaît

projet-bonjour-console-1

- Cliquez droit sur l’îcone ’src’ pour créer une nouvelle classe New/class

projet-bonjour-new-class

L’écran suivant apparaît

projet-bonjour-new-class-1

- Ajoutez le nom de la classe ’Bonjour’ dans le champ Name
- Puis sélectionnez la case à cocher ’public static void main(String[] args)’ pour que Eclipse génère la méthode main() , caractéristique d’une classe principale , porte d’entrée de l’application Java SE.

projet-bonjour-new-class-1

- Cliquez sur le bouton ’Finish’

projet-bonjour-new-class-2

Partie 5 : numéroter des lignes de code

- Cliquez droit sur la bordure prés du code

show-line-numbers

- Sélectionnez ’Show Line Numbers’
- L’écran suivant apparaît , mettant en évidence les numéros de ligne

show-line-numbers-1

Partie 6 : identifier rapidement les méthodes d’une classe

Analyser le contenu de la vue ’Outline’

vu-outline

Interprétation

- Nous sommes en présence d’une classe nommée ’Bonjour’
- La classe Bonjour ne possède qu’une méthode nommée ’main’.
- La méthode main() prend en paramêtre un tableau d’Objets de type Chaîne de caractères (String)
- La méthode main() ne retourne rien.
- La méthode est statique

Partie 7 : sauvegarder régulièrement votre travail

Sur le code généré à la ligne 5 , remplacez ’Auto-generated method stub’ par ’Afficher ’Bonjour Objis’

Sauvegarde-auto

Vous remarquez que suite à une modification du code, une étoile apparaît à coté du nom du fichier ouvert (ici Bonjour.java)
- Sauvegarder le code du fichier code source Bonjour.java (combinaison des deux touches clavier CTRL + S ou appui sur l’icone ENREGISTRE du menu représenté par une disquette) L’étoile a disparu

Sauvegarde-auto

Partie 8 : identifier les taches AVANT de coder

Les lignes commençant par // TODO permettent de préciser un commentaire associé à une tache Il est bien de commenter une tache AVANT de coder.

- Ajouter la vue ’Tasks’ qui permet de lister l’ensemble des TODO du projet (quelque soit le nombre de fichiers sources du projet java)

view-task

L’écran suivant apparaît :

view-task-1

- En double-cliquant sur la tache , vous arrivez sur la ligne de code du commentaire de la tache. Pratique si vous n’avez pas eu le temps de coder mais vous savez les taches à réaliser.

view-task-2

Partie 9 : coder en utilisant les raccourcis ECLIPSE

Dans cette partie nous allons découvrir l’utilité de :
- CTRL + ESPACE
- La touche ’.’ Afin d’écrire la ligne de code suivant qui va afficher ’Bonjour Objis’ dans la vue Console : System.out.println(’’Bonjour Objis’’) ; Mettez le curseur sur la ligne suivant la ligne du commentaire TODO

raccourci-eclipse

Vous allez ainsi commencer le codage.
- Ecrire les deux premières lettres de la classe System

raccourci-eclipse-1

Notez la croix rouge, symbole que notre code ne compile pas. Normal car la classe ’Sy’ n’existe pas.

- Solliciter Eclipse pour qu’il complète le nom de la classe en tapant la combinaison de touche CTRL + ESPACE

raccourci-eclipse-2

QUESTION : d’où viennent toutes les propositions que formule Eclipse ?
- Sélectionnez la classe ’System’ en double cliquant sur cette classe ou en tapant la touche ENTREE une fois sélectionnée.

raccourci-eclipse-3

Notez la croix rouge, symbole que notre code ne compile pas. Normal car nous n’avons pas terminé notre instruction.
- Après le mot System, cliquez sur la touche point ’.’

raccourci-eclipse-4

Que s’est t’il passé ?
- Sélectionnez la propriété ’out’ de la classe System
- Après le mot ’out’, cliquez à nouveau sur la touche ’point’ et sélectionner la méthode ’println’

raccourci-eclipse-5

L’écran suivant apparaît :

raccourci-eclipse-6

- Entrez ’Bonjour Objis’ à la place de ’x’

raccourci-eclipse-7

Sauvegardez

raccourci-eclipse-7

Partie 10 : Formater le code

Cliquer sur les touches CTRL+SHIFT+F

raccourci-eclipse-8

Quel impact sur le code ? Expliquez

Partie 11 : Compiler avec Eclipse

La compilation est automatique par défaut. C’est configuré dans les options de configuration du compilateur dans Eclipse.

Partie 12 : exécuter l’application sous Eclipse

Cliquer sur le bouton associé à l’exécution :

eclipse-execution

Ensuite, voir le contenu de la vue ’console’

eclipse-execution-1

Expliquez

Partie 13 : utiliser les modèles ’template’ Eclipse

Supprimez le contenu de notre ligne de code de façon à revenir comme au début de notre codage :

template-eclipse

Nous allons cette fois utiliser un modèle eclipse pour arriver au même résultat. Taper uniquement la lettre ’sy’

template-eclipse-1

- Saisissez la combinaison CTRL + ESPACE

template-eclipse-2

- Sélectionnez ’sysout’ , puis ENTREE

template-eclipse-3

Expliquez. Que s’est t’il passé ?

Pour le comprendre, analysez la configuration d’Eclipse : Menu Window/Preferences/Java/Editors/Templates et sélectionnez le template ’sysout’

template-eclipse-4

Partie 14 : Ajouter la documentation des méthodes et de la classe

Mettez le curseur dans la méthode main()

template-eclipse-5

Menu Source/Generate Element Comment

template-eclipse-6

Tapez la combinaison de touche : ALT + SHIFT + J

template-eclipse-7

Ajoutez un commentaire

template-eclipse-8

Mettez le curseur à l’intérieur de la classe Bonjour, mais hors de la méthode main()

template-eclipse-9

Tapez la combinaison de touche : ALT + SHIFT + J

template-eclipse-10

Expliquez

Partie 15 : Voir la javadoc dans Eclipse

Considerez le code suivant pour lequel nous souhaitons avoir des informations sur la classe ’System’

- Mettez le curseur au dessus du mot ’System’

javadoc-eclipse

- Mettez le curseur dans la zone de documentation

Que se passe t’il ? d’autres options apparaissent...

javadoc-eclipse-1

...et permettent d’afficher la Javadoc de la classe ’System’ dans Eclipse, comme le montre l’écran suivant :

javadoc-eclipse-2

Partie 16 : Générer la javadoc de votre projet

Cette partie est traitée sur le tutoriel suivant , le tutoriel N° 6 , Comment documenter son programme JAVA avec l’outil javadoc .

BRAVO !

Conclusion

Dans ce tutoriel java N°5, vous avez appris les premières bonnes pratiques de développement dans l’environnement Eclipse.

Votre avis nous intéresse

Vous avez remarqué une erreur ? Vous avez une recommandation pour améliorer ce tuto ? Vous souhaitez nous encourager à partager notre savoir-faire technique et pédagogique ?

Donner votre avis sur ce Tuto objis.com