Est-il une norme de style pour la documentation de PHP?

Je suis nouveau développement en PHP, et je me demandais si la communauté a des lignes directrices en ligne de la documentation de code à l'aide des commentaires. J'aimerais quelque chose comme Python PEP 257, mais j'aimerais régler pour un format utilisé par le populaire document de l'outil d'extraction, ou même que la documentation standard d'un produit populaire.

InformationsquelleAutor jwhitlock | 2010-06-28
  1. 11

    Le plus largement utilisé forme de la documentation de l'API pour PHP est phpDocumentor un.k.un. phpdoc. Beaucoup de IDEs sont aussi en mesure d'extraire de l'information pour améliorer l'auto-complétion des allusions à l'aide de phpDocumentor style API docs.

    InformationsquelleAutor Daniel Egeberg
  2. 6

    Utilisation phpdoc (très similaire à la javadoc)

    InformationsquelleAutor Paul Tarjan
  3. 4

    PHPdoc est la première chose qui vient à l'esprit, jetez un oeil à http://www.phpdoc.org/

    InformationsquelleAutor jordanstephens
  4. 4

    La phpdoc (phpDocumentor) style est commun. Il utilise DocComments contenant DocBlocks.

    <?php
/**
 * This is a DocBlock for a function.
 */
function associatedFunction()
{
}

<?php
/**
 * I belong to a file
 */

/**
 * I belong to a class
 */
class Def
{
}

    Étiquettes et annotations:

     <?php
 /**
  * A summary informing the user what the associated element does.
  *
  * A *description*, that can span multiple lines, to go _in-depth_ into the details of this element
  * and to provide some background information or textual references.
  *
  * @param string $myArgument With a *description* of this argument, these may also
  *    span multiple lines.
  *
  * @return void
  */
  function myFunction($myArgument)
  {
  }

    Source

    InformationsquelleAutor Person
  5. 3

    POIRE (PHP Extension and Application Repository) a les normes de codage qui comprend un exemple de fichier à l'aide de phpDocumentor, ainsi que certaines autres conventions.

    InformationsquelleAutor jwhitlock