62 lines
2.8 KiB
HTML
62 lines
2.8 KiB
HTML
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
|
|
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
|
|
<title>phpcompta: PhpCompta</title>
|
|
<link href="doxygen.css" rel="stylesheet" type="text/css">
|
|
</head><body>
|
|
<!-- Generated by Doxygen 1.4.4 -->
|
|
<div class="qindex"><a class="qindexHL" href="index.html">Main Page</a> | <a class="qindex" href="namespaces.html">Namespace List</a> | <a class="qindex" href="hierarchy.html">Class Hierarchy</a> | <a class="qindex" href="annotated.html">Data Structures</a> | <a class="qindex" href="dirs.html">Directories</a> | <a class="qindex" href="files.html">File List</a> | <a class="qindex" href="functions.html">Data Fields</a> | <a class="qindex" href="globals.html">Globals</a> | <a class="qindex" href="pages.html">Related Pages</a></div>
|
|
<h1>PhpCompta </h1>
|
|
<p>
|
|
<h3 align="center">1 </h3><h2><a class="anchor" name="intro_sec">
|
|
Introduction</a></h2>
|
|
Cette partie contient de la documentation pour les développeurs.<h2><a class="anchor" name="convention_code">
|
|
Convention de codage</a></h2>
|
|
Quelques conventions de codage pour avoir un code plus ou moins homogène <ol>
|
|
<li>
|
|
Tant que possible réutiliser ce qui existe déjà, </li>
|
|
<li>
|
|
Améliorer ce qui existe déjà et vérifier que cela fonctionne toujours </li>
|
|
<li>
|
|
Documenter avec les tags doxygen votre nouveau code, </li>
|
|
<li>
|
|
Les noms de fichiers sont *.inc.php pour les fichiers à éxécuter </li>
|
|
<li>
|
|
Les noms de fichiers sont *.php pour les fichiers contenant des fonctions uniquement </li>
|
|
<li>
|
|
Les noms de fichier sont class_*.php pour les fichiers contenant des classes. </li>
|
|
<li>
|
|
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 </li>
|
|
<li>
|
|
Faire de la doc </li>
|
|
</ol>
|
|
<h2><a class="anchor" name="conseil">
|
|
Conseils</a></h2>
|
|
Utiliser cette documentation, elle est générée automatiquement avec Doxygen, <ul>
|
|
<li>
|
|
Related contient tous les \todo </li>
|
|
<li>
|
|
Global -> function pour lire toute la doc sur les fonctions </li>
|
|
<li>
|
|
Regarder dans dossier1.html et account_repository.html pour la doc des base de données </li>
|
|
</ul>
|
|
et il ne faut connaître que 7 tags <ul>
|
|
<li>
|
|
\file en début de fichier </li>
|
|
<li>
|
|
\todo ajouter un todo </li>
|
|
<li>
|
|
\enum pour commenter une variable </li>
|
|
<li>
|
|
\param pour commenter le paramètre d'une fonction </li>
|
|
<li>
|
|
\brief Commentaire du fichier, de la fonction ou de la classe </li>
|
|
<li>
|
|
\note des notes, des exemples </li>
|
|
<li>
|
|
\return ce que la fonction retourne </li>
|
|
</ul>
|
|
<hr size="1"><address style="align: right;"><small>Generated on Tue Jun 27 01:39:26 2006 for phpcompta by
|
|
<a href="http://www.doxygen.org/index.html">
|
|
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.4 </small></address>
|
|
</body>
|
|
</html>
|