Vos commentaire d'entête - PHP - Programmation
Marsh Posté le 13-03-2006 à 11:45:34
Berceker United > Généralement, je laisse les commentaires rajouté par mon éditeur de texte. Ce n'est que si je dois passer un fichier à quelqu'un d'autre que je remplis l'entête un peu plus soigneusement.
Et puis bon, je conais pas les "balises" des systémes de doc tel que phpdocumentor alors je fais comme je peux. Je sais juste que mon éditeur de texte mets des "@author" et autres nom du genre.
Marsh Posté le 13-03-2006 à 11:46:47
omega2 a écrit : Berceker United > Généralement, je laisse les commentaires rajouté par mon éditeur de texte. Ce n'est que si je dois passer un fichier à quelqu'un d'autre que je remplis l'entête un peu plus soigneusement. |
@author
@licence
etc c'est du phpdoc
merci quand même
Marsh Posté le 13-03-2006 à 11:53:08
Où comment bien faire les chôses sans le savoir.
Marsh Posté le 13-03-2006 à 12:05:09
perso c'est l'auteur, une petite description de la classe ( avec précision sur les héritages si besoin), la liste des principales révisions et eventuellement un todo....
Marsh Posté le 13-03-2006 à 13:07:14
j'utilise les normes phpDoc également. Donc :
Description succinte de la classe, d'une ligne.
Description détaillée de la classe
Auteur
Date
version
Marsh Posté le 13-03-2006 à 13:13:18
il me semble pas que la date soit implémenté directement.
Marsh Posté le 13-03-2006 à 13:15:40
au temps pour moi, je mets la date entre parenthèse derrière l'info de version (@version)
Marsh Posté le 12-03-2006 à 18:13:40
Bonjours.
J'ai juste une question parmis ceux qui sont conciencieux dans leurs travaille.
Comment organisez vous vos entête de fichiers scripts ?
Pour ma part je documente mes classes avec la norme de phpdocumentor mais pour les fichiers d'affichage j'ai déjà quelque truc mais peut être que c'est pas bon ou il manque des éléments.
date,module,description,auteur,mail,...
Vous que mettez-vous?
Message édité par Berceker United le 13-03-2006 à 11:42:35