Présentation
Les « docblocks » sont des commentaires PHP spécifiques dans le code pour documenter celui-ci. Ils commencent par /** et se terminent par */. En général, le signe * crée un filet vertical :
/**
* Ceci est un docblock
*/Par convention, la première ligne sert de description courte de la fonction. Elle peut être suffisante ou non. Si une description plus longue doit être apportée, il faut sauter une ligne entre les deux :
/**
* Ceci est la description courte, généralement sur une seule ligne
*
* Ceci est une description longue, facultative. Elle commence après la ligne
* vide qui suit la description courte
*/Le contenu à l’intérieur de ces blocs s’écrit en utilisant une syntaxe Markdown. Celle-ci bien que très pratique a quelques subtilités. La plus importante à connaître, c’est que toute liste d’éléments a aussi une ligne vide avant :
/**
* Ceci est la description courte, généralement sur une seule ligne
*
* Ceci est une description longue
*
* - Et ceci est un élément de liste (il doit y avoir une ligne vide avant)
* - Et un autre élément.
*/Insérer du code
On peut citer du code de trois manières, entre
<span class="base64" title="<code class="spip_code spip_code_inline" dir="ltr">&lt;/code&gt;, indenté de 4 espaces, ou entre multiples &lt;code&gt;&lt;div class=&quot;base64&quot; title=&quot;PGRpdiBjbGFzcz0icHJlY29kZSI+PHByZSBjbGFzcz0ic3BpcF9jb2RlIHNwaXBfY29kZV9ibG9jayIgZGlyPSJsdHIiIHN0eWxlPSJ0ZXh0LWFsaWduOiBsZWZ0OyI+PGNvZGU+Jmx0Oy9jb2RlJmd0OyAob3UgdW4gbcOpbGFuZ2UgZGVzIDIgZGVybmllcnMpIDoNCiZsdDtjYWRyZSBjbGFzcz0ncGhwJyZndDsNCi8qKg0KICogQ2VjaSBlc3QgYGR1IGNvZGUgZW4gbGlnbmVgDQogKg0KICogQ2VjaSBlc3QgdW5lIGRlc2NyaXB0aW9uIGxvbmd1ZQ0KICoNCiAqICAgICBDZWNpIGVzdCBhdXNzaSB1biBibG9jIGRlIGNvZGUgc3VyIHBsdXNpZXVycyBsaWduZXMuIA0KICogICAgIElsIGZhdXQgdW5lIGxpZ25lIHZpZGUgZXQgdW5lIGluZGVudGF0aW9uIGQnYXUgbW9pbnMgNCBlc3BhY2VzLg0KICogIA0KICogPC9jb2RlPjwvcHJlPjwvZGl2Pg==&quot;&gt;&lt;/div&gt;
 * Ceci est aussi du code sur plusieurs lignes
 * &lt;div class=&quot;base64&quot; title=&quot;PGRpdiBjbGFzcz0icHJlY29kZSI+PHByZSBjbGFzcz0ic3BpcF9jb2RlIHNwaXBfY29kZV9ibG9jayIgZGlyPSJsdHIiIHN0eWxlPSJ0ZXh0LWFsaWduOiBsZWZ0OyI+PGNvZGU+ICogICAgICA8L2NvZGU+PC9wcmU+PC9kaXY+&quot;&gt;&lt;/div&gt;
 * &nbsp; &nbsp; &nbsp;Ceci est encore du code
 * &nbsp; &nbsp; &nbsp;&lt;div class=&quot;base64&quot; title=&quot;PGRpdiBjbGFzcz0icHJlY29kZSI+PHByZSBjbGFzcz0ic3BpcF9jb2RlIHNwaXBfY29kZV9ibG9jayIgZGlyPSJsdHIiIHN0eWxlPSJ0ZXh0LWFsaWduOiBsZWZ0OyI+PGNvZGU+ICovDQombHQ7L2NhZHJlJmd0Ow0KDQoNCnt7e0xlcyB0YWdzfX19DQoNCkxlcyAndGFncycgc29udCBjb21tZSBkZXMgdmFyaWFibGVzIHF1aSBzZXJ2ZW50IMOgIGTDqWNyaXJlIG5vdHJlIGZvbmN0aW9uLiBJbHMgZG9ubmVudCBkZXMgaW5mb3JtYXRpb25zIGVuIHBsdXMgcGFyIHJhcHBvcnQgYXV4IGRlc2NyaXB0aW9ucyBjb3VydGVzIGV0IGxvbmd1ZXMuIFVuIHRhZyBzJ8OpY3JpdCBgQG5vbV9kdV90YWdgIGV0IGlsIHBldXQgcydlbiBzdWl2cmUgdW4gY2VydGFpbiBjb250ZW51LCBlbiBmb25jdGlvbiBkdSB0YWcuDQoNClZvaWNpIGRvbmMgcXVlbHF1ZXMgZXhlbXBsZXMgZGUgdGFncyA6DQoNCiZsdDtjYWRyZSBjbGFzcz0ncGhwJyZndDsNCi8qKg0KICogRGVzY3JpcHRpb24gY291cnRlDQogKg0KICogQGFwaQ0KICogQHNlZSBjaGVtaW4oKQ0KICogQGxpbmsgaHR0cDovL3d3dy5zcGlwLm5ldC8uLi4NCiAqLw0KJmx0Oy9jYWRyZSZndDsNCg0Ke3t7TGlzdGUgZGVzIHRhZ3MgZGUgUEhQRG9jfX19DQoNClN1ciBsYSBjYXTDqWdvcmlzYXRpb24gKGfDqW7DqXJhbGVtZW50IHBvdXIgbCdlbnTDqnRlIGRlIGZpY2hpZXIpIDoNCi0qICZsdDtjb2RlJmd0O0BwYWNrYWdlIHgmbHQ7L2NvZGUmZ3Q7IDogSW5kaXF1ZSBxdWUgbCfDqWzDqW1lbnQgcmVncm91cMOpIGRhbnMgeA0KLSogJmx0O2NvZGUmZ3Q7QHBhY2thZ2UgU1BJUFxDb3JlXHgmbHQ7L2NvZGUmZ3Q7IDogSW5kaXF1ZSBxdWUgbCfDqWzDqW1lbnQgZXN0IGR1IFNQSVAsIGRhbnMgbGUgQ29yZSwgcHVpcyBkYW5zIHVuIHNvdXMgw6lsw6ltZW50IHgNCi0qICZsdDtjb2RlJmd0O0BwYWNrYWdlIFNQSVBcQnJldmVzXHgmbHQ7L2NvZGUmZ3Q7IDogSW5kaXF1ZSBxdWUgbCfDqWzDqW1lbnQgcmVncm91cMOpIGRhbnMgbGUgcGx1Z2luIEJyw6h2ZXMsIHB1aXMgZGFucyBsZSBzb3VzIMOpbMOpbWVudCB4Lg0KDQombHQ7ZGl2IGNsYXNzPSdpbmZvJyZndDsNCnt7TGEgbGlzdGUgZGVzIHNvdXMgw6lsw6ltZW50cyBlc3QgZW5jb3JlIMOgIGTDqWZpbmlyIHBsdXMgcHLDqWNpc8OpbWVudC59fQ0KT24gdHJvdXZlIGFjdHVlbGxlbWVudCA6IEluc3RhbGxhdGlvbiwgQXV0b3Jpc2F0aW9ucywgUGlwZWxpbmVzLCBBY3Rpb24sIGRlIGZhw6dvbiBhc3NleiBnw6luw6lyaXF1ZS4gQ2VjaSByZXN0ZSDDoCBwcsOpY2lzZXIuDQombHQ7L2RpdiZndDsNCg0KU3VyIGwndXNhZ2UgZGUgbCfDqWzDqW1lbnQgOg0KLSogJmx0O2NvZGUmZ3Q7QGFwaSZsdDsvY29kZSZndDsgOiBJbmRpcXVlIHF1ZSBsJ8OpbMOpbWVudCBlc3QgdW5lIEFQSQ0KLSogJmx0O2NvZGUmZ3Q7QGRlcHJlY2F0ZWRbIHRleHRlXSZsdDsvY29kZSZndDsgOiBJbmRpcXVlIHF1ZSBsJ8OpbMOpbWVudCBlc3QgZMOpcHLDqWNpw6kgZXN0IG5lIGRvaXQgcGx1cyDDqnRyZSB1dGlsaXPDqS4gTGUgdGV4dGUgcGV1dCBzZXJ2aXIgw6AgaW5kaXF1ZXIgbCdhbHRlcm5hdGl2ZSDDoCB1dGlsaXNlci4NCg0KU3VyIGxlcyBsaWVucyBlbnRyZSDDqWzDqW1lbnRzIGV0IGRvY3VtZW50YXRpb25zIDoNCi0qICZsdDtjb2RlJmd0O0BzZWUgZWxlbWVudCBbdGV4dGVdJmx0Oy9jb2RlJmd0OyA6IGluZGlxdWUgdW4gcmVudm9pZSB2ZXJzIHVuIGF1dHJlIMOpbMOpbWVudA0KLSogJmx0O2NvZGUmZ3Q7QHVzZXMgZWxlbWVudCBbdGV4dGVdJmx0Oy9jb2RlJmd0OyA6IGluZGlxdWUgcXVlIGxhIGZvbmN0aW9uIHV0aWxpc2UgY2V0IMOpbMOpbWVudA0KLSogJmx0O2NvZGUmZ3Q7QGxpbmsgdXJsIFt0ZXh0ZV0mbHQ7L2NvZGUmZ3Q7IDogaW5kaXF1ZSB1biByZW52b2llIHZlcnMgdW5lIHJlc3NvdXJjZSBleHRlcm5lDQoNClN1ciBsZXMgcGFyYW3DqHRyZXMgOg0KLSogJmx0O2NvZGUmZ3Q7QHBhcmFtIHR5cGUgJHZhciBbdGV4dGVdJmx0Oy9jb2RlJmd0OyA6IGluZGlxdWUgcXVlIGxlIHBhcmFtw6h0cmUgJHZhciBkZSBsYSBmb25jdGlvbiBlc3QgZHUgdHlwZSBpbmRpcXXDqS4gT24gcGV1dCBpbmRpcXVlciBwbHVzaWV1cnMgcG9zc2liaWxpdMOpcyBhdmVjICZsdDtjb2RlJmd0O3wmbHQ7L2NvZGUmZ3Q7IDogJmx0O2NvZGUmZ3Q7aW50fHN0cmluZ3xudWxsICR2YXImbHQ7L2NvZGUmZ3Q7LiBMb3JzcXUnaWwgeSBhIHBsdXNpZXVycyBwYXJhbcOodHJlcywgZXQgZG9uYyBwbHVzaWV1cnMgZm9pcyBsZSB0YWcgYEBwYXJhbWAsIHZlaWxsZXogw6AgY29uc2VydmVyIGxlIG3Dqm1lIG9yZHJlIHF1ZSBsZXMgcGFyYW3DqHRyZXMgZGUgbGEgZm9uY3Rpb24sIGV0IGxlcyBtw6ptZXMgbm9tcyBkZSB2YXJpYWJsZS4NCi0qICZsdDtjb2RlJmd0O0ByZXR1cm4gdHlwZSZsdDsvY29kZSZndDsgOiBwYXJlaWwgcXVlIEBwYXJhbSBwb3VyIGxlcyByZXRvdXJzIGRlIGxhIGZvbmN0aW9uLiBOb3RleiBxdWUgc2kgbGEgZm9uY3Rpb24gbmUgcmV0b3VybmUgcmllbiAoYXVjdW4gbW90IGNsw6kgJmx0O2NvZGUmZ3Q7cmV0dXJuJmx0Oy9jb2RlJmd0OyBkYW5zIGxlIGNvZGUgZGUgbGEgZm9uY3Rpb24pLCB2b3VzIHBvdXZleiBvbWV0dHJlIEByZXR1cm4sIG91IGluZGlxdWVyICZsdDtjb2RlJmd0O0ByZXR1cm4gdm9pZCZsdDsvY29kZSZndDsuIE5vdGV6IGF1c3NpIHF1ZSAmbHQ7Y29kZSZndDtAcmV0dXJuIG51bGwmbHQ7L2NvZGUmZ3Q7IGVzdCBkaWZmw6lyZW50IGRlICZsdDtjb2RlJmd0O0ByZXR1cm4gdm9pZCZsdDsvY29kZSZndDsuIFZvdXMgcG91dmV6IGN1bXVsZXIgcGx1c2lldXJzIHJldG91cnMgYmllbiDDqXZpZGVtbWVudCB0ZWwgcXVlICZsdDtjb2RlJmd0O0ByZXR1cm4gdm9pZHxpbnR8c3RyaW5nJmx0Oy9jb2RlJmd0Ow0KDQpBdXRyZXMgdGFncyA6DQotKiAmbHQ7Y29kZSZndDtAZXhhbXBsZSBbdGV4dGVdJmx0Oy9jb2RlJmd0OyBzZXJ0IMOgIGRvbm5lciB1biBvdSBwbHVzaWV1cnMgZXhlbXBsZXMuIFMnaWwgeSBhIGR1IGNvZGUgZGFucyBsJ2V4ZW1wbGUsIGlsIGRvaXQgw6p0cmUgw6ljaGFwcMOpIHNlbG9uIGwndXNhZ2UsIHBhciBleGVtcGxlIMOqdHJlIG1pcyBlbnRyZSAmbHQ7Y29kZSZndDs8L2NvZGU+PC9wcmU+PC9kaXY+&quot;&gt;&lt;/div&gt;&lt;/code&gt;.
-* &lt;code&gt;@todo [texte]&lt;/code&gt; indique quelque chose qui reste à faire !


{{{Tags spécifiques à SPIP}}}

-* &lt;code&gt;@note [texte]&lt;/code&gt; Indique un commentaire plutôt en relation avec le code interne de la fonction
-* &lt;code&gt;@balise&lt;/code&gt; Indique que la fonction compile une balise &lt;code&gt;#XX&lt;/code&gt;
-* &lt;code&gt;@filtre&lt;/code&gt; indique que la fonction peut servir de filtre dans un squelette
-* &lt;code&gt;@critere&lt;/code&gt; indique que la fonction compile un critère
-* &lt;code&gt;@boucle&lt;/code&gt; indique que la fonction compile une boucle
-* &lt;code&gt;@pipeline xx&lt;/code&gt; indique que la fonction est traversée lors de l'appel par le pipeline xx. La fonction peut donc compléter des données sur le pipeline.
-* &lt;code&gt;@pipeline_appel xx&lt;/code&gt; indique que la fonction appelle la fonction &lt;code&gt;pipeline()&lt;/code&gt; avec le pipeline xx pour en obtenir des données


{{{ Exemples pour des fonctions }}}

&lt;cadre class='php'&gt;
/**
 * Donne le nom de la copie locale de la source
 *
 * Soit obtient l'extension du fichier directement de l'URL de la source,
 * soit tente de le calculer.
 *
 * @uses nom_fichier_copie_locale()
 * @uses recuperer_infos_distantes()
 *
 * @param string $source
 * &nbsp; &nbsp; &nbsp;URL de la source distante
 * @return string
 * &nbsp; &nbsp; &nbsp;Nom du fichier calculé
**/
function fichier_copie_locale($source){
&lt;/cadre&gt;
&lt;cadre class='php'&gt;

/**
 * Retourne le nombre de lignes d’une ressource de sélection obtenue
 * avec</code>"></span>sql_select()`
*
* @api
* @see sql_select()
* @see sql_countsel()
*
* @param Ressource $res
* Ressource SQL
* @param string $serveur
* Nom du connecteur
* @param bool|string $option
* Peut avoir 2 valeurs :
*
* - true -> executer la requete
* - continue -> ne pas echouer en cas de serveur sql indisponible
* @return bool|string
* - int Nombre de lignes,
* - false en cas d'erreur.
**/
function sql_count($res, $serveur='', $option=true) {
</cadre>
{{{En-tête de fichiers}}}
PHPDocumentor n'est pas content lorsqu'il n'a pas de phpdoc pour un en-tête de fichier. Comme pour les fonctions, il est bon que chaque fichier décrive plus ou moins laconiquement leur contenu. Exemples :
(mauvais exemple, il manque les accents !)
<cadre class='php'>
/**
* Definition de l'API SQL
*
* Ce fichier definit la couche d'abstraction entre SPIP et ses serveurs SQL.
* Cette version 1 est un ensemble de fonctions ecrites rapidement
* pour generaliser le code strictement MySQL de SPIP <= 1.9.2
* Des retouches sont a prevoir apres l'experience des premiers portages.
* Les symboles sql_* (constantes et nom de fonctions) sont reserves
* a cette interface, sans quoi le gestionnaire de version dysfonctionnera.
*
* @package SPIP\Core\SQL\API
* @version 1
*/
</cadre>
Ou plus simplement :
<cadre class='php'>
/**
* Gestion de l'action activer_plugins
*
* @package SPIP\Core\Plugins
**/
</cadre>
{{{Éléments obligatoires et optionnels}}}
PHPDocumentor loge une erreur dès que certains PHPDoc sont absents. Ils sont normalement obligatoires sur ces éléments :
-* entête de fichier
-* fonction
-* classe
-* propriété de classe
-* méthode de classe
Il est aussi possible d'en mettre sur les constantes déclarées (mais alors juste avant sa déclaration, pas avant un éventuel <code>ifqui la précède. L’autodoc peut alors générer la liste des constantes présente dans le code source, avec une belle description à côté.
Exemple :
if (!defined('_DIR_RESTREINT_ABS')) {
/** le nom du repertoire ecrire/ */
define('_DIR_RESTREINT_ABS', 'ecrire/');
}