Conventions de nommage et organisation du code

Module

Chaque module consiste en un fichier .c et .h, portant le nom du module et contenu dans un dossier portant le nom du module, ainsi qu'un fichier test.c et un Makefile pour le test. Si possible, les test devraient être fait avec CUnit.

Exemple de structure pour le module ocean :

src
|-ocean
| |- ocean.h
| |- ocean.c
| |- test.c
| |- Makefile

Chaque fichier de chaque module devra comporter l'en-tête suivant :

/* Module <nomdumodule>
 * <description du module>
 * Auteurs : <...>
 * Date de création : <...>
 * Date de dernière modification : <...>
 * Raison de la dernière modification : <...>
 */

Types

module_T_JoueurCategorie

Fonctions

En-tête de chaque fonction :

/* Nom de la fonction : <...>
 * <description>
 * Paramètre : Type nom_param
 * Rôle du paramètre : ...
 * Paramètre 2 : ...
 * Rôle du paramètre 2 : ...
 * ...
 */

Nom :

module_placer (verbe infinitif)
module_initialiser_plateau

Ordre des paramètres : plateau, joueur, coordonnées

Le code de la fonction devra être commenté en fonction de l'algorithme.

Variable

nombre_bateaux