[SPIP Zone] Appel à commentaires sur une série d'articles de programmer.spip.org

Salut la liste,

j’ai écrit il y a peu une série d’articles sur les règles d’écriture et de documentation du code PHP.
L’objectif est qu’on arrive à avoir du code lisible, facile à maintenir et à reprendre.

C’est par ici : http://programmer.spip.org/ecrire/?exec=naviguer&id_rubrique=94

Pouvez-vous apporter des commentaires, suggestions, ou signaler des oublis ? (voire écrire des articles complémentaires)

Sont soumis à commentaires :

En préparation :

  • Recommandations pour les thèmes
  • Validation des données
  • Le jargon SPIP
  • Accolades
  • Commentaires
  • switch, else if, ou elseif

- Usage des espaces

  • Les fichiers

Si vous avez d’autres idées, je suis preneur…

Merci d’avance,

.Gilles

Le 04/05/2010 14:48, Gilles VINCENT a écrit :

Salut la liste,

j'ai écrit il y a peu une série d'articles sur les règles d'écriture et
de documentation du code PHP.
L'objectif est qu'on arrive à avoir du code lisible, facile à maintenir
et à reprendre.

Super !

Pouvez-vous apporter des commentaires, suggestions, ou signaler des
oublis ? (voire écrire des articles complémentaires)

La plupart des commentaires ont déjà été mis à Matthieu et Cédric en dessous de chaque article. Moi très rapidement j'avais noté :
- pas de camel case en recommandation
- donc dans *tous* les autres exemples il faut l'enlever
- pas d'abréviation dans les noms (donc faut les enlever aussi dans les exemples)
- enlever le premier paragraphe de "Conventions d'écriture" qui dénigre le code actuel : c'est vrai mais ce livre n'est pas là pour analyser et critiquer l'existant mais pour donner des recommandations positives
- quelques fautes d'orthographes

J'avais vu d'autres choses mais comme pour l'instant j'ai juste lu rapidos en diagonale...

- Recommandations pour les thèmes

C'est quoi que tu appelles "les thèmes" ?

Parce que pour l'instant il n'y a que deux choses qui utilisent ce terme :
- les thèmes de ZPIP
- les thèmes de l'espace privé (mais le concept n'est pas encore finalisé je crois)

Donc dans les deux cas, ça n'a rien à faire là pour l'instant.

Si vous avez d'autres idées, je suis preneur..

Il faut des recommandations sur le découpage du code. Notamment l'assemblage des noms de dossier/fichiers/fonctions qui permettent d'utiliser la fonction "charger_fonctions()".

Par exemple charger_fonctions('truc', 'inc/') qui va chercher inc/truc.php et dedans inc_truc_dist(). Mais qu'on peut alors surcharger facilement.

Il faut donc des recommandations sur les noms à donner et le découpage, et en même temps dire qu'il faut utiliser charger_fonction() pour appeler.

Bien entendu ça ne vaut que pour les fonctions / librairie de fonctions que l'on veut pouvoir être surchargeable.

--
RastaPopoulos

Quel benêt je fais…
Vu que je n’avais pas de notification, je n’ai pas eu le réflexe d’aller regarder dans les articles ^^.

2010/5/4 RastaPopoulos <rastapopoulos@spip.org>

Le 04/05/2010 14:48, Gilles VINCENT a écrit :

Salut la liste,

j’ai écrit il y a peu une série d’articles sur les règles d’écriture et
de documentation du code PHP.
L’objectif est qu’on arrive à avoir du code lisible, facile à maintenir
et à reprendre.

Super !

Pouvez-vous apporter des commentaires, suggestions, ou signaler des
oublis ? (voire écrire des articles complémentaires)

La plupart des commentaires ont déjà été mis à Matthieu et Cédric en dessous de chaque article. Moi très rapidement j’avais noté :

  • pas de camel case en recommandation
  • donc dans tous les autres exemples il faut l’enlever

J’avais opté pour un choix plus libre, mais effectivement l’usage actuel dans la plupart du code est la convention avec ‹ _ ›. Adopté !

  • pas d’abréviation dans les noms (donc faut les enlever aussi dans les exemples)

J’ai précisé la construction des termes, sur laquelle j’avais juste indiqué que c’était « vraiment pas simple »

  • enlever le premier paragraphe de « Conventions d’écriture » qui dénigre le code actuel : c’est vrai mais ce livre n’est pas là pour analyser et critiquer l’existant mais pour donner des recommandations positives

Bien vu. Je devais être dans une phase de déprime lorsque j’ai écrit ce paragraphe :wink:
J’en ai tenu compte pour une nouvelle proposition.

  • quelques fautes d’orthographes

Bon, j’ai fais mon possible

J’avais vu d’autres choses mais comme pour l’instant j’ai juste lu rapidos en diagonale…

  • Recommandations pour les thèmes

C’est quoi que tu appelles « les thèmes » ?

Parce que pour l’instant il n’y a que deux choses qui utilisent ce terme :

  • les thèmes de ZPIP
  • les thèmes de l’espace privé (mais le concept n’est pas encore finalisé je crois)

Donc dans les deux cas, ça n’a rien à faire là pour l’instant.

je voulais faire un équivalent à http://codex.wordpress.org/Theme_Development_Checklist
(il s’agit plutôt des squelettes : le squelette ZPIP est un squelette qui respecte assez bien cette liste)

Si vous avez d’autres idées, je suis preneur…

Il faut des recommandations sur le découpage du code. Notamment l’assemblage des noms de dossier/fichiers/fonctions qui permettent d’utiliser la fonction « charger_fonctions() ».

Par exemple charger_fonctions(‹ truc ›, ‹ inc/ ›) qui va chercher inc/truc.php et dedans inc_truc_dist(). Mais qu’on peut alors surcharger facilement.

J’en étais resté au include_spip() :confused:

Il faut donc des recommandations sur les noms à donner et le découpage, et en même temps dire qu’il faut utiliser charger_fonction() pour appeler.

Tu as parfaitement raison

Bien entendu ça ne vaut que pour les fonctions / librairie de fonctions que l’on veut pouvoir être surchargeable.

Dans le cadre d’un plugin, on devrait coder avec cet objectif en tête, il me semble, non ?

.Gilles