Projet 7 : Documentation et sp�cifications

Ce projet est relativement simple et va aborder les probl�mes de documentation et sp�cification. Comment documenter du code, sp�cifier des m�thodes, g�n�rer la documentation ? Ce projet apporte des r�ponses � ces diff�rentes questions.

Le probl�me

Le probl�me n'est donc pas bien compliqu� car on va surtout se concentrer sur la documentation du code. Ce qu'on veut faire, c'est �crire une classe qui repr�sente un pion. Ce pion serait ensuite utilis� pour �crire un programme de jeu de plateau par exemple.

Afin de faire un programme propre et extensible, on va tout d'abord �crire une interface qui repr�sente un pion, ensuite un type �num�r� pour repr�senter les mouvements du pion et enfin, on va �crire une classe qui impl�mente l'interface.

D�finition de l'interface Piece

Une fois le projet Projet7 cr�� dans Eclipse, cr��z donc une nouvelle interface de nom Piece. Cette interface va d�finir deux m�thodes qui permettent d'obtenir la position du pion et de d�placer le pion. L'interface ressemble donc actuellement � :