Classes, fonctions, comment décrire leur syntaxe ?

Classes, fonctions, comment décrire leur syntaxe ? - PHP - Programmation

Marsh Posté le 03-01-2007 à 23:49:55    

Bonjour à tous et bonne année.
 
Tout d'abord merci à tous pour votre aide sur ce forum, elle est toujours aussi précieuse.
 
 
Je cherche depuis quelque temps à détailler la syntaxe de mes classes PHP.
Je m'explique:
 
je crée des classes (ou fonction) php persos, comme tout le monde je pense, afin de faciliter différentes taches.
Une fonction demande différents parametres selon son action (bon là je vous apprend rien).
 
Je voudrai décrire chaque fonction selon son action et ses paramètres.
Les paramêtres peuvent être optionnelle ou pas, d'un certain type, sensible à la case, selon une liste définit, etc...
 
Je pensais utiliser par cela L'Extended Backus-Naur form (EBNF) http://fr.wikipedia.org/wiki/EBNF
J'ai aussi essayé de copier le principe de la DTD mais c'est trop usine à gaz.
 
Existe-t-il une autre solution ?
 
Comment faites-vous ?
 
Par avance, merci.
 
Olivier.

Message cité 1 fois
Message édité par nothing le 04-01-2007 à 00:33:13
Reply

Marsh Posté le 03-01-2007 à 23:49:55   

Reply

Marsh Posté le 04-01-2007 à 14:22:33    

tu veux les décrire à quel endroit ? dans tes fonctions (/classes) ?

 

Persos je décris juste ce que fait la fonction, ensuite je donne des noms aux arguments suffisament explicite pour ne pas poser de probléme, et enfin je commente un maximum mes lignes de code. (enfin surtout les points importants )

 

EDIT : avant je mettais les arguments, et je les décrivais, mais ça me prennais trop de temps pour un gain, que j'ais jugé non significatif. En fait ce qui prennais du temps c'était la MàJ de ces arguments.


Message édité par chani_t le 04-01-2007 à 14:24:06
Reply

Marsh Posté le 05-01-2007 à 11:21:23    

nothing a écrit :

Je cherche depuis quelque temps à détailler la syntaxe de mes classes PHP.


Tu veux donc documenter tes classes, c'est bien ça ?

Reply

Marsh Posté le 05-01-2007 à 11:27:40    

en phpdoc, c'est bien je trouve...

Reply

Marsh Posté le 22-05-2008 à 10:17:02    

Bonjour à tous.
 
Je reprend le travail où je l'avais laissé.
 
Je pense en effet utilisé le format phpdoc donc via un docbook.
 
Le problème est que je ne sais pas comment lire et écrire un docbook via php, je creuse du coté de xslt...
 

Reply

Marsh Posté le 22-05-2008 à 12:00:30    

Je comprends pas ce que tu essayes de faire, là? Phpdoc est là pour tout automatiser, qu'est-ce qu'il te faut que ça ne fait pas déjà?


---------------
Can't buy what I want because it's free -
Reply

Marsh Posté le 22-05-2008 à 13:24:23    

+1


---------------
Directeur Technique (CTO)
Reply

Sujets relatifs:

Leave a Replay

Make sure you enter the(*)required information where indicate.HTML code is not allowed