Introduction

Cette partie contient de la documentation pour les développeurs.

Convention de codage

Quelques conventions de codage pour avoir un code plus ou moins homogène

Tant que possible réutiliser ce qui existe déjà,
Améliorer ce qui existe déjà et vérifier que cela fonctionne toujours
Documenter avec les tags doxygen votre nouveau code,
Dans le répertoire include: Les noms de fichiers sont *.inc.php pour les fichiers à exécuter
Dans le répertoire include: Les noms de fichiers sont *.php pour les fichiers contenant des fonctions uniquement
Dans le répertoire include: Les noms de fichier sont class_*.php pour les fichiers contenant des classes.
Dans le répertoire include: Les noms de fichier ajax* correspondent aux fichiers appelé par une fonction javascript en ajax, normalement le nom de fichier est basé sur le nom de la fonction javascript exemple pour la fonction javascript anc_key_choice le fichier correspondant est ajax/ajax_anc_key_choice.php
Dans le répertoire include/template: les fichiers de présentation HTML
Utiliser sql/upgrade.sql comme fichier temporaire pour modifier la base de données, en général ce fichier deviendra l'un des patch
Faire de la doc

Utiliser cette documentation, elle est générée automatiquement avec Doxygen,

Related contient tous les \todo
Global -> function pour lire toute la doc sur les fonctions
Regarder dans dossier1.html et account_repository.html pour la doc des base de données

et il ne faut connaître que ces tags

\file en début de fichier
\todo ajouter un todo
\enum pour commenter une variable
\param pour commenter le paramètre d'une fonction
\brief Commentaire du fichier, de la fonction ou de la classe
\note des notes, des exemples
\throw or exception is a function can throw an exception
\par to create a new paragraph
\return ce que la fonction retourne
\code et \endcode si on veut donner un morceau de code comme documentation
\verbatim et \endverbatim si on veut donner une description d'un tableau, comme documentation
\see xxxx Ajoute un lien vers un fichier, une fonction ou une classe