wiki:Documentation/Fr/Developpeur/CodingStandards

Version 8 (modified by nico, 7 years ago) (diff)

--

Standard de Code

Voici les standards à suivre absolument et ceux qui sont conseillés pour la production et la maintenance du code d'AlternC.

Programmation

Le choix du langage à utiliser est détaillé avec l'InfrastructureLogicielle.

PHP

  • Magic_Quotes = aucune supposition, le code doit marcher quelque soit la position.
  • Register_Globals = supposé OFF, et le code doit marcher s'il est ON.
  • commentaires à la PHPDocumentor  http://pear.php.net/package/phpdocumentor (/ */ signale un commentaire avec tags explicatifs)
  • commentaires en anglais si possible, noms de variables anglophones
  • les fonctions de classes nommées _xxx sont privées et celles nommées alternc_xxx sont des fonctions d'évènements réservées
  • style: on suit les  coding standards de PEAR
  • le code doit être valide PHP4 et PHP5

Shell

Le shell de prédilection est bash.

Perl

Il serait souhaitable (par économie et simplicité) d'utiliser le shell à la place lorsque possible. Perl ne semble utilisé que pour le script source:trunk/src/du.pl .

C

Il serait souhaitable (par économie et simplicité) de ne pas utiliser de langages compilés. C ne semble utilisé que dans 7 programmes de source:trunk/src/, pour obtenir l'uid root; le shell ne supportant pas setuid, il faudrait envisager d'utiliser des solutions alternatives, ultérieurement (cron|sudo|suphp|perlsuid).

Packaging Debian

Tout d'abord suivre au plus près la debian-policy, dernière du nom, disponible ici :  http://www.debian.org/doc/debian-policy/