Automatique de la Documentation PHP de Génération?

Pour ActionScript 2, j'ai utilisé NaturalDocs. Cependant, il est assez mauvais support de PHP. Je l'ai cherché jusqu'à présent à doxygen et phpDocumentor, mais leur production est assez moche à mon avis. Quelqu'un a une expérience avec de génération automatique de documentation de PHP? Je préfère être en mesure d'utiliser la javadoc-les balises de style, ils sont à court d'écrire et facile à retenir.

OriginalL'auteur davr | 2008-10-09

  1. 21

    ApiGen

    http://apigen.org/

    ApiGen a le support de PHP 5.3 espaces de noms, les paquets, les liens entre les documents, de références croisées pour PHP classes standard et de la documentation générale, la création de mise en surbrillance le code source et le support expérimental pour PHP 5.4 traits.

    DocBlox

    http://www.docblox-project.org/

    PHP 5.3 compatible API générateur de Documentation destiné à des projets de toutes tailles et d'Intégration Continue.

    pleinement en mesure de analyser et transformer Zend Framework 2

    Je tiens à mentionner que DocBlox est le même que phpDocumenter au-dessous de la réponse. De 3, c'est le seul qui n'a pas mixup espaces de noms, mais peut-être que je suis tout simplement pas obtenir quelque chose et d'avoir une fin de nuit pet cerveau. 😉
    ApiGen est un non-non si vous êtes à l'aide de quelques trucs de php 5.6 ou 7. Ils sont sur le point de la version 4.2, donc j'espère qu'ils vont résoudre les problèmes... parce que j'aime leur disposition.
    Je n'ai jamais utiliser docblox avant, mais j'ai essayé apigen et phpdocumentor, apigen est le seul (que je n'avais jamais essayé) qui est capable de générer le document sans exposer le code source et de son document généré est très facile à comprendre.

    OriginalL'auteur M A Hossain Tonu

  2. 16

    Il y a deux bien connue et souvent utilisée outil qui peut générer de la doc API à partir d'éléments :

    • phpDocumentor, qui est spécifique à PHP, et est probablement l'un des plus utilisés outil pour les projets PHP
    • et Doxygen, qui est plus pour le C, mais il est utilisé pour PHP par certaines personnes.


    Sur les "lignes directrices" : je dirais que cela dépend de vos projets, mais, au moins, je m'attends à voir :

    • une description de la méthode/fonction ne
    • paramètres, avec @param type name description of the parameter
    • valeur de retour, avec @return type description of the return value
    • exceptions, avec @throws type description of the exception that can be thrown

    Une grande chose que de récentes IDE (comme Eclipse PDT, par exemple), peut lire et interpréter ces marqueurs, de donner des conseils quand vous êtes de codage 😉


    Aussi, il existe de plus en plus d'outils PHP qui utilisent des éléments php pour un autre but que celui de la documentation.

    Par exemple, PHPUnit vous permet de spécifier quelques test-liés choses en utilisant certaines balises -- voir Les Annotations.

    Je vous remercie pour la très approfondie de la réponse. En particulier, ce qui correspond à ce que je suis habitué à l'écriture pour le JavaScript (typées dynamiquement vars et params), donc vu que je ne suis pas contraint, je vais aller avec quelque chose qui est ce que je suis habitué.

    OriginalL'auteur Pascal MARTIN

  3. 6

    PHPDoc est probablement aussi bonne que vous l'aurez en termes de Javadoc style de commentaires en ligne. Vous pouvez également regarder PHPXRef.

    PHPXRef n'a pas été mis à jour depuis 2010

    OriginalL'auteur Kornel Kisielewicz

  4. 5

    Oui, phpDocumentor (http://www.phpdoc.org/) est une norme acceptable outil pour PHP autodocs. C'est le standard de facto.

    Il est admis à suivre le général JavaDoc lignes directrices pour le code lors de la fixation de code PHP. Cependant, vous allez courir dans les cas où cela n'est pas suffisant parce que PHP et Java sont des langues différentes.

    Par exemple, les fonctions de PHP ont pas de type de retour et c'est inévitable (et parfois souhaitable) pour une fonction pour renvoyer un type avec un contexte et un autre type avec un deuxième contexte. JavaDoc lignes directrices ne vont pas aider à cela, car il est impossible de le faire en Java.

    Merci pour le renforcement de l'. J'ai parfois attendre PHP, un peu moins comme un langage de script, mais plus je l'utilise, il me semble que le côté serveur de composant de script JavaScript j'ai l'habitude d'écrire.
    Bien que votre exemple est valide, d'une manière générale, si java ne permet pas de quelque chose et php, je voudrais essayer de correspondre à ce que java recommande et ne pas le faire en php, même si je le pouvais...

    OriginalL'auteur Alan Storm

  5. 4

    phpDocumentor pouvez sortie dans un style similaire à la php.net de la documentation (et ses construit en avec les deux smarty et non smarty layouts)

    C'est une excellente option, mais gardez à l'esprit que les fichiers contenant des traits ou php7 du retour ou de l'argument de la déclaration de type sont ignorés par la version actuelle (2.9.0).

    OriginalL'auteur Ólafur Waage

  6. 4

    Découvrez PHPDoctor http://peej.github.com/phpdoctor/, un simple mais plein de fonctionnalités Javadoc clone pour PHP.

    OriginalL'auteur Paul James

  7. 3

    Le WordPress base de code est documenté à l'aide de tags phpdoc (voir cette) et il est généralement assez bon rendu ici à l'aide de phpDocumentor.

    Plus du code que j'écris c'est assez important que j'ai besoin de penser à autogenerating docs pour est fait .Net, donc je ne peux pas donner beaucoup de documentation de l'écrivain de point de vue si

    OriginalL'auteur cori

  8. 1

    Si vilain est un problème, je venais de basculer la feuille de style pour un programme personnalisé. Si vous ne voulez pas écraser le générés, vous pouvez utiliser un plugin Firefox comme Élégant.

    OriginalL'auteur Aupajo

  9. 0

    Vous pouvez modifier le fichier de modèle à ajouter votre propre feuille de style pour remplacer l'existant.

    OriginalL'auteur Darryl Hein