Recommandations

Recommandation de présentation
Les rapports sont présentés selon les normes habituelles de l'enseignement supérieur.

1. Les rapports sont dactylographiés.

Structure des documents

0- Page de garde

1-Présentation
L'énoncé du travail.
Des explications utiles et synthétiques sur votre stratégie.

2-Modélisation
Les cas d'utilisations (que doit faire le programme ?)
Le diagramme de classes.
Les diagrammes de scénario.

3- Implémentation et documentation
L'impression de la documentation javadocs.
Le code en JAVA commenté selon les normes javadocs.

4- Conclusion

Recommandations techniques
Voici un ensemble de recommandations pour permettre d'écrire des programmes mieux conçus et plus « objet ».

1. L’écriture d’un programme est un art au sens ancien du métier artisanal. L'écriture réclame un certain « tour de main » . Un travail bien fait se reconnaît au fait qu’il a été conçu intelligemment (et non pas codé à toute vitesse dans tous les sens) et que sa structure présente une certaine harmonie.

Utilisez votre sens esthétique pour déterminer si un programme est correct ou non : un « beau » programme a plus de chance de tourner et d’être évolutif que du code jeté à la va vite..

2. Il faut que le code des classes soit cohérent avec le diagramme. Pensez aussi à l’implémentation des relations. Pour une association ou une agrégation avec une cardinalité ‘*’, utilisez un Vector. Si au contraire le nombre des éléments est fixe, utilisez un tableau.

3. Il faut toujours rechercher la généricité dans un programme. Ecrivez toujours un programme comme si vous deviez le modifier et l’étendre le lendemain pour lui ajouter des fonctionnalités. En particulier : évitez les structures de données inutiles, toutes les techniques ‘ad hoc’ que l’on n’utilise que pour résoudre un tout petit cas particulier.

4. Utilisez les mots-clés javadocs pour vos commentaires.

5. Recherchez la simplicité et la lisibilité de votre programme. Un bon programme est un programme simple. Moins il y a de lignes de code, tout en étant lisible (pas d’astuces qui diminuent en fait la lisibilité du code), plus votre programme a de chances d’être extensible et donc rapidement fonctionnel. La simplicité et la lisibilité sont les clefs de la bonne programmation.

6. En programmation objet : toujours rechercher à utilisez la hiérarchie des classes et l’envoi de message. C’est un mécanisme très puissant. En particulier n’utilisez JAMAIS un champ ‘type’ (ou ‘nature’ ou ‘sorte’) avec des méthodes qui font des tests sur ces types, utilisez toujours l’héritage à la place.

7. Ne pas confondre héritage avec composition. L’héritage répond à la question ‘sorte de’ (un chien est une sorte de animal), alors que l’agrégation (et la composition) répond à la question ‘partie de’ (la tête d’un chien est une partie de ce chien).

8. Essayez que vos objets agissent par eux mêmes : pensez que chaque objet est un petit être qui agit par lui même. N’agissez pas sur les objets comme s’il s’agissait de structures de données passives, demandez aux objets d’agir !

(Eric Derasse & J.Ferber)

Sauf mention contraire, le contenu de cette page est protégé par la licence Creative Commons Attribution-ShareAlike 3.0 License