Programmer Orienté Objet en Java

Une chose essentielle lorsqu'on code. Il est toujours essentiel de garder son code compréhensible.

On a vu que pour ça, il existe les commentaires.

Mais nous n'avons pas encore vu les commentaires JavaDoc qui sont très utiles.

 

1. Les commentaires JavaDoc

Ces fameux JavaDoc permettent de renseigner des informations sur les méthodes de nos classes. Voyons ça au travers d'un exemple :

C'est ainsi que l'on ajoute les commentaires JavaDoc, pour voir l'utilité de ceux-ci, pointer description() avec votre souris.

 

Vous obtenez alors les informations que vous avez données dans votre commentaires JavaDoc.

Et en plus, cela permet de créer une documentation sur notre code. Pour cela il faut la créer via l'onglet Project > Generate Javadoc.

 

En plus d'ajouter les commentaires JavaDoc, l'autre chose qu'il faut faire pour rendre votre code le plus lisible possible et d'utiliser des packages.

 

2. Les packages

Les packages sont l'équivalents des dossiers de vos ordinateurs. Au lieu de ranger vos documents, ils permettent de ranger vos classes.

 

Les utiliser comporte plusieurs avantages :

• importation facilitée vers une autre application ;
• décharger notre package par défaut ;
• ranger nos classes.

 

Pour créer un package, il faut cliquer sur ce bouton :

 

Vous tombez alors sur cette boite de dialogue

Il faut alors remplir le nom que l'on veut donner à notre package. 

 

Mais avant ça, il faut tenir compte de la convention de nommage qui existe.

La voici :

• Tous les noms de package doivent être écrits en minuscule ;
• Seul les caractères alphanumériques (a à z, de 0 à 9) et peuvent contenir des points ;
• Aucun mot clef du Java ne doit être contenu dans le nom, si c'est le cas, il doit obligatoirement être suivi d'un underscore ;
• Tout package doit commencer par com, edu, gov, mil, net, org ou les deux lettres permettant d'identifier un pays (fr pour la france par exemple).

 

Vous pouvez donc créer votre premier package, mais attention à bien respecter cette convention.

 

Petit rappel :

Dans le cours sur les bases du Java, je vous avais parlé des portées de vos classes, méthodes, etc; Je vous avais notamment parlé qu'il était possible de ne pas mettre de mot clef.

L'absence de mot clef et le mot public sont assez proche. La différence est qu'avec le mot clef public, la classe sera visible à la fois de l'interieur de son package, mais aussi à l'extérieur de celui-ci. Alors que sans mot clef, la porté de notre classe se limitera à son package. 

 

Voyons maintenant comment définir qu'une classe est dans un package. Dans le cas où votre classe est déjà créée, il faut lui spécifier le package dans lequel on souhaite l'ajouter. Pour cela, il existe deux façons, soit on ajoute ce code ci : package nomdemonpackage; avant votre classe. La seconde façon est d'aller dans l'explorateur de projet, de transférer via un click prolongé la classe dans le package que vous souhaitez.

Dans le cas où vous souhaitez créer une nouvelle classe et l'associer directement dans un package, il suffit qu'au moment de sa création, vous remplissez le champs dédié au package.