PHPDoc - Historique des versions

Paul le 25 juin 2009 à 07:32

2009-06-25T07:32:44Z

Paul : /* Syntaxes */

2009-06-24T15:24:51Z

‎Syntaxes

Jeraiz : /* Syntaxes */

2009-06-24T11:59:38Z

‎Syntaxes

Jeraiz : /* Syntaxes */

2009-06-24T11:55:13Z

‎Syntaxes

Jeraiz : /* Syntaxes */

2009-05-26T13:33:08Z

‎Syntaxes

Jeraiz : /* Syntaxes */

2009-05-26T13:24:40Z

‎Syntaxes

Jeraiz : /* Syntaxes */

2009-05-26T13:15:44Z

‎Syntaxes

Jeraiz : /* Syntaxes */

2009-05-26T13:07:30Z

‎Syntaxes

Jeraiz : /* Syntaxes */

2009-05-26T13:05:55Z

‎Syntaxes

Jeraiz : /* Syntaxes */

2009-05-26T13:03:27Z

‎Syntaxes

@@ Ligne 7 : / Ligne 7 : @@
 Commentaire sur une propriété de classe :
 <source lang="php">
-    /**
-     * Message de bienvenue
+/**
+ * Message de bienvenue
-     * @var    string message de bienvenue
-     * @access private
+ * @var    string message de bienvenue
-     */
+ * @access private
-    var $message;
+ */
 </source>
 Commentaire sur une méthode de classe :
 <source lang="php">
-    /**
+/**
-     * Créé le message
+ * Créé le message
-     * et le stocke dans $this->message
+ * et le stocke dans $this->message
-−
+ *
-     * @access  public
+ * @access  public
-     * @return  none
+ * @return  none
-     */
+ */
-    function creationMessage() {
+function creationMessage() {
-−
+}
 </source>

@@ Ligne 44 : / Ligne 44 : @@
 Pour préciser la version d'une fonction, l'auteur d'une classe ou encore le type de l'objet, on utilise des tags préfixés par le caractère arobas @ :
-{| class="wikitable"
+{| class="prettytable sortable"
 |+ Tags PHPDoc
 ! Tag

@@ Ligne 97 : / Ligne 97 : @@
+|
 |Indique que l'objet est statique
 |-
 |@throws

@@ Ligne 32 : / Ligne 32 : @@
 ==Syntaxes==
-On utilise la balise de commentaires pour lignes multiples :
+On utilise la balise de commentaires pour lignes multiples (les 2 étoiles en première ligne sont nécessaires à l'interprétation des commentaires comme étant du PHPDoc) :
 <source lang="php">
-/* */
+/**
 </source>

@@ Ligne 72 : / Ligne 72 : @@
 |-
 |@global
-|type (string, int, boolean, array, object NomObjet...) $globalvarname
+|type(string, int, boolean, array, object NomObjet...) $globalvarname
 |Variable globale.
 |-
@@ Ligne 84 : / Ligne 84 : @@
 |-
 |@param
-|type [$varname] description
+|type(string, int, boolean, array, object NomObjet...) [$varname] description
+|Décrit un paramètre à une fonction
 |-
 |@return
-|type description
+|type(string, int, boolean, array, object NomObjet...) description
-|This tag should not be used for constructors or methods defined with a ''void'' return type.
+|Définit la valeur de retour d'une fonction.
-|-
-|@see
-−
-|Documents an association to another method or class.
-|-
-|@since
-|version
-|Documents when a method was added to a class.
 |-
 |@static
+|
-|Documents a static class or method
+|Indique que l'objet est statique
-|-
-|@staticvar
-−
-|Documents a static variable's use in a function or class
 |-
 |@throws
+|
-|Documents an exception thrown by a method.
+|Exception lancée par une méthode (voir aussi @throws).
 |-
 |@todo
+|
-|Permet d'indiquer une descriptino d'une tâche à accomplir prochainement sur l'objet.
+|Permet d'indiquer une description d'une tâche à accomplir prochainement sur l'objet.
 |-
 |@var
-|type de l'objet (string, int, boolean, array, object NomObjet)
+|type(string, int, boolean, array, object NomObjet)
 |Type de la propriété
 |-

@@ Ligne 66 : / Ligne 66 : @@
 |version
 |Indique que l'objet est obsolète.
 |-
 |@exception
+|
-|documents an exception thrown by a method &mdash; also see @throws.
+|Exception lancée par une méthode (voir aussi @throws).
 |-
 |@global
-|type $globalvarname
+|type (string, int, boolean, array, object NomObjet...) $globalvarname
-|Documents a global variable or its use in a function or method.
+|Variable globale.
-|-
-|@ignore
-−
-|Prevents the documentation of an element
-|-
-|@internal
-−
-|private information for advanced developers
 |-
 |@link
 |URL
+|URL associée à l'objet (redirection vers une documentation)
-|-
-|@name
-|global variable name
-|Specifies an alias for a variable.  For example, $GLOBALS['myvariable'] becomes $myvariable
-|-
-|@magic
-−
-−
 |-
 |@package
-|name of a package
+|nom du package
-|Documents a group of related classes and functions.
+|Nom du package de l'objet.
 |-
 |@param
@@ Ligne 126 : / Ligne 106 : @@
+|
 |Documents a static variable's use in a function or class
 |-
 |@throws
@@ Ligne 137 : / Ligne 113 : @@
 |@todo
+|
-|Documents things that need to be done to the code at a later date.
+|Permet d'indiquer une descriptino d'une tâche à accomplir prochainement sur l'objet.
 |-
 |@var
-|type
+|type de l'objet (string, int, boolean, array, object NomObjet)
-|a data type for a class variable
+|Type de la propriété
 |-
 |@version
+|
-|Provides the version number of a class or method.
+|Version de l'objet.
 |}
 Pour plus d'informations sur les tags, vous pouvez voir ces sites : [http://en.wikipedia.org/wiki/PHPDoc Wikipedia PHPDoc], [http://manual.phpdoc.org/HTMLSmartyConverter/HandS/phpDocumentor/tutorial_tags.pkg.html PHPDocumentor manuel]...

@@ Ligne 42 : / Ligne 42 : @@
 {| class="wikitable"
-|+ Common tags
+|+ Tags PHPDoc
 ! Tag
-! Usage
+! Valeurs
 ! Description
 |-
 |@abstract
+|
-|Documents an abstract class, class variable or method.
+|L'objet est abstrait.
 |-
 |@access
 |public, private or protected
-|Documents access control for an element.  @access private indicates that documentation of element be prevented.
+|Accessibilité de l'objet.
 |-
 |@author
-|author name <author@email>
+|Nom de l'auteur de l'objet <emaildelauteur@email.com>
-|Documents the author of the current element.
+|Nom et adresse e-mail de l'auteur
 |-
 |@copyright
-|name date
+|nom date
-|Documents copyright information.
+|Copyright.
 |-
 |@deprecated
 |version
-|Documents a method as deprecated.
+|Indique que l'objet est obsolète.
-|-
-|@deprec
-−
-|same as @deprecated
 |-
 |@example

@@ Ligne 39 : / Ligne 39 : @@
 Le premier paragraphe est dédié à la description courte de l'objet commenté, le deuxième à la description longue.
-Pour préciser la version d'une fonction, l'auteur d'une classe ou encore le type de l'objet, on utilise des tags préfixés par le caractère arobas @.
+Pour préciser la version d'une fonction, l'auteur d'une classe ou encore le type de l'objet, on utilise des tags préfixés par le caractère arobas @ :
 '''@author Société Cantico'''
@@ Ligne 48 : / Ligne 48 : @@
 Version de l'objet