* 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 à éxé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/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
*
*
*
* \section conseil Conseils
*
* 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
*
*----------------------------------------------------------------------
*\page English
* \section intro_sec Introduction
*
* This parts contains documentation for developpers
*
* \section convention_code Coding convention
*
* Some coding conventions to have a homogene code
*
*
Reuse the existing code ,
*
Improve and check that the function is still working
*
Make documentation thanks doxygen tag
*
In the folder include: filenames ending by *.inc.php will be executer after being included
*
Dans le répertoire include: Les noms de fichiers sont *.php pour les fichiers contenant des fonctions uniquement
*
In the folder include: filenames end by *.php if they contains only function
*
In the folder include: filenames starting with
* class_*.php if it is related to a class.
*
In the folder include/template: files for the HTML presentation
*
*
Use sql/upgrade.sql as temporary file to modify the database,this file will be the base for a SQL patch
*
*
Write documentation
*
*
*
* \section advice Advices
*
* Use this document, it is generated automatically by doxygen, check the documentation your made, read it first this
* documentation before making change
*
*
Related contains all the \\todo
*
Global -> all the functions
*
check into mod1.html and account_repository.html for the database design
*
* You need to know only this tags
*
*
\\file in the beginning of a file
*
\\todo add a todo
*
\\enum comment a variable
*
\\param about the parameter of a function
*
\\brief Documentation of the file, function or class
*
\\note note exemple
*
\\throw or exception is a function can throw an exception
*
\\par to create a new paragraph
*
\\return what the function returns
*
\\code and \\endcode code snippet given as example
*
\\verbatim and \\endverbatim if we want to keep the formatting without transformation
*
\\see xxxx create a link to the file, function or object xxxx
