Le PHPDoc dans le code source - commentaires Le PHPDoc dans le code source 2014-05-02T13:37:23Z https://code.spip.net/fr/fonctionnement-du-site-et-des-documentations/article/le-phpdoc-dans-le-code-source#comment45 2014-05-02T13:37:23Z <p>Dans le cas d'une fonction dépréciée qui sert juste d'alias pour une autre fonction, faut-il utiliser touts les tags ou on peut se contenter de <code class="spip_code" dir="ltr">@deprecated</code> + <code class="spip_code" dir="ltr">@see</code> ?<br class="autobr" /> Par exemple :</p> <p><strong>A) version courte :</strong></p> <div class="precode"><pre dir="ltr" style="text-align: left;" class="php"><code><span style="color: #009933; font-style: italic;">/**<br /> * @deprecated Utiliser nouveau_toto()<br /> * @see nouveau_toto()<br /> */</span><br /> <span style="color: #000000; font-weight: bold;">function</span> vieux_toto<span style="color: #009900;">&#40;</span><span style="color: #000088;">$arg</span><span style="color: #009900;">&#41;</span><span style="color: #009900;">&#123;</span><br /> <span style="color: #b1b100;">return</span> nouveau_toto<span style="color: #009900;">&#40;</span><span style="color: #000088;">$arg</span><span style="color: #009900;">&#41;</span><br /> <span style="color: #009900;">&#125;</span></code></pre></div> <p><strong>B) version complète :</strong></p> <div class="precode"><pre dir="ltr" style="text-align: left;" class="php"><code><span style="color: #009933; font-style: italic;">/**<br /> * Description courte<br /> *<br /> * Description détaillée<br /> *<br /> * @deprecated Utiliser nouveau_toto()<br /> * @see nouveau_toto()<br /> *<br /> * @param type $arg<br /> * explication<br /> * @return type<br /> * explication<br /> */</span><br /> <span style="color: #000000; font-weight: bold;">function</span> vieux_toto<span style="color: #009900;">&#40;</span><span style="color: #000088;">$arg</span><span style="color: #009900;">&#41;</span><span style="color: #009900;">&#123;</span><br /> <span style="color: #b1b100;">return</span> nouveau_toto<span style="color: #009900;">&#40;</span><span style="color: #000088;">$arg</span><span style="color: #009900;">&#41;</span><br /> <span style="color: #009900;">&#125;</span></code></pre></div>