phpdoc Exemples sans numéros de ligne

Question

Selon la documentation de PHPDocumentor, pour montrer un exemple, il serait comme ceci:

@example [location] [<start-line> [<number-of-lines>] ] [<description>] 

Cela semble être une solution valable si le code ne change jamais, mais chaque fois que vous allez ajouter un nouveau code à chaque fois l'emplacement est, votre ligne de départ change potentiellement ce qui signifie que vous devez constamment mettre à jour ces différentes références. Existe-t-il un meilleur moyen de montrer un exemple d'utilisation d'une méthode de classe, dans le DocBlock, sans faire référence à un exemple d'utilisation courante externe?

Voici ce que je visais:

/** 
* @example This is how you use this method: 
* 
*  $baz = Foo::bar(array('bing' => $bing)); 
*/ 

Et puis il apparaît dans la documentation à titre d'exemple. Des idées?

Answer 1

Vous pouvez afficher un exemple de code dans le docblock lui-même au moyen du délimiteur "code". Donc, pour votre exemple original: section

/** 
* This is how you use this method: 
* <code> 
*  $baz = Foo::bar(array('bing' => $bing)); 
* </code> 
*/ 

La page de manuel [1] pour la balise @example montre à la fois un « code » dans le docblock ainsi que des pointeurs @example à des lignes dans des fichiers séparés.

[1] - http://manual.phpdoc.org/HTMLSmartyConverter/HandS/phpDocumentor/tutorial_tags.example.pkg.html