• Taiwen Jiang <phppp@users.sourceforge.net>

Ce document fournit les normes et les directives de codage pour les développeurs et les équipes travaillant sur ou avec le projet XOOPS. Les sujets traités sont :

• Formatage des fichiers PHP
  • Généralités
  • Indentation
  • Longueur maximale des lignes
  • Fin de Ligne
• Conventions de nommage
• Proposition globale
• Abstractions utilisées dans les api (interfaces de classes)
• Classes
• Interfaces
• Noms des fichiers
• Noms des dossiers
• Fonctions et méthodes
  • Paramètres optionnels
• Variables
• Constantes
• Variables
• Définitions de langue
• Booléens et la valeur NULL
• Noms des 'templates' de modules
• Règles de codage
  • Délimiteur de code PHP
  • Chaînes
  • Constantes de chaîne
  • Constantes de chaîne contenant des apostrophes
  • Substitution de variable
  • Concaténation de chaine
  • Tableaux
    • Tableau à index numérique
    • Tableaux associatifs
  • Classes
    • Déclarations de classes
    • Variables de classe
  • Fonctions et méthodes
    • Déclaration de fonctions et de méthodes
    • Utilisation des fonctions et méthodes
  • Instructions de contrôle
    • If / Else / Elseif
    • Switch
• Documentation intégrée
  • Format de documentation
  • Fichiers
  • Classes
  • Fonctions
  • Require / Include
• Erreurs et exceptions
• Explications

• Développeurs XOOPS : Développeurs qui contribuent aux 'frameworks' XOOPS, incluant
  • Développeurs du noyau : Développeurs qui contribuent au SVN du noyau de XOOPS et dont le code sera employé par des développeurs d'application XOOPS.
  • Développeurs du 'framework' : Développeurs qui contribuent aux 'frameworks' de XOOPS qui pourraient être adoptés dans le noyau de XOOPS à l'avenir.
  • Développeurs d'interface utilisateur : Développeurs qui travaillent sur les thèmes de XOOPS et les 'templates' de modules.
• Créateurs d'applications XOOPS : Développeurs qui créent leurs propres applications sur la plate-forme XOOPS
  • Développeurs de modules : Développeurs qui construisent des modules tiers utilisant la plate-forme et les bibliothèques XOOPS.

De bonnes normes de codage sont importantes dans n'importe quel projet de développement, en particulier lorsque plusieurs développeurs travaillent sur un même projet. Avoir des normes de codage aide à s'assurer que le code est de qualité, a peu de bogues et est facile à maintenir.

Les buts abstraits que nous poursuivons :

• simplicité extrême
• outil convivial, à travers l'utilisation des signatures de méthode, constantes et modèles qui soutiennent des outils d'IDE et les propositions automatisées lors de la saisie de nom de méthode, de classe et noms de constantes.

Au vu des buts ci-dessus, chaque situation exige un examen des circonstances et de l'équilibrage des compromis.

L'équipe de développement de Xoops a le plaisir de vous annoncer la sortie de la version Xoops 2.3.0 RC. L'objectif des versions Xoops 2.3 est de fusionner les deux branches existantes 2.0 et 2.2 afin de construire une passerelle pour la future génération du système Xoops 3.0.

Avec les versions Xoops 2.3, les utilisateurs auront la possibilité de découvrir quelques unes des nouvelles fonctionnalités qui seront disponibles dans xoops 3.0, les développeurs pourront mieux comprendre la direction du développement Xoops, les designers s'exerceront avec quelques fonctions qui seront supportées dans le futur. Une double compatibilité, ascendante et descendante, sera assurée dans la mesure du possible.

Les modules écrits pour les versions 2.0 et 2.3 fonctionneront avec les versions 2.3. Les applications développées pour les versions 2.3 seront compatibles automatiquement avec Xoops 3.0. Les développeurs sont encouragés à écrire leurs modules d'applications sur xoops 2.3 pour incorporer quelques unes des nouvelles fonctionnalités et s'assurer ainsi une migration plus aisée vers Xoops 3.0.

La version RC (release candidate) publiée aujourd'hui est gelée dans ses fonctionnalités, elle contient cependant quelques améliorations mineures qui figure dans cet article.