10
votes

Générateur de documentation phpdoc dans ou hors éclipse?

Je développe avec Eclipse + PDT. J'ai ajouté des commentaires phpdoc à mon code, mais en fait n'a jamais généré une documentation résultante dans Eclipse. Comment devrais-je le faire - existe-t-il des fonctionnalités dans Eclipse ou la génération DOC devrait être faite à l'extérieur?

php eclipse documentation phpdoc

0 commentaires

3 Réponses :

1
votes

Oui, il y a un magicien pour le faire à Zend. Découvrez ce BREF GUIDE .

Vous pouvez également créer une configuration de lancement externe pour appeler la norme phpdocumentor .

Sélectionnez Exécution -> Outils externes-> Configurations d'outils externes ...
Dans le volet de gauche, sélectionnez Programme puis la nouvelle icône (icône la plus à gauche au-dessus du volet).
Dans le volet de droite, sélectionnez l'onglet principal.
Entrez Generate_Doc dans le nom: Champ.
Entrez le chemin d'accès à l'outil CLI phpdoc à l'emplacement: champ.
Entrez les arguments requis dans le champ Arguments, par exemple. Pour l'entrée actuelle du projet $ {Project_Loc}.
Pour exécuter la configuration externe, sélectionnez Exécuter.
Pour relancer la configuration que vous avez quelques choix:
1. Sélectionnez l'icône Outils externe dans la barre de menus Outils externes icône http://help.eclipse.org/ganmede/topic/org.eclipse.cdt.doc.utilisateur/images/icon%5fext%5fools.png " puis cliquez sur Generate_Doc
2. Sélectionnez Run-> Outils externes-> Generate_Doc
3. HIT ALT + R, E, 1 (En supposant que Generate_Doc est le premier élément de la liste, sinon choisir le numéro approprié)

1 commentaires

Merci, mais j'utilise régulièrement Eclipse + PDT, apparemment, il n'y a pas une telle option.

5
votes

Pour générer la documentation, vous devez utiliser phpdocumentor , qui peut être installé comme package de poirier. < / p>

Ensuite, vous devez l'appeler de la ligne de commande; Je ne l'ai jamais vu appelé d'Eclipse PDT, en fait.

Une excellente solution consiste à avoir une plate-forme d'intégration continue (en utilisant PHPunSControl , par exemple) et intègre à la création du phpdoc dans votre fichier de configuration de construction; De cette façon, le phpdoc est généré à chaque fois que quelqu'un commet (ou une fois par jour, ou chaque fois que vous le souhaitez ^^) . .

dans Eclipse PDT, vous pouvez appeler "Outils externes" (voir "Exécuter> Outils externes" dans le menu); Cela vous permettrait de lancer la commande phpdoc (comme vous le faites de CLI); Mais cela n'est certainement pas aussi convivial que ce que propose Zend Studio offre - pas le même prix non plus, bien que ^^

1 commentaires

J'ai utilisé la fourmi pour construire mes projets PHP et disposer d'une cible DOC. Eclipse joue très bien avec la fourmi. Aussi, vous exécutez Phing d'Eclipse.

2
votes

Un autre excellent outil pour générer une documentation est Apigen . Il n'a pas besoin d'installation avec de la poire (mais comprend) et il peut être utilisé comme un package autonome.

7 commentaires

Comment installons-nous apigen pour Windows? J'ai téléchargé le paquet phar , mais il n'y a pas d'indice comme comment procéder.
@Suhailgupta jetez un oeil ici: Github.com/apigen/apigen J'ai donc inclus le chemin C: \ wamp \ www \ apigen.phar dans la variable utilisateur chemin et également à l'intérieur du système système . Mais ça ne marche pas! Imprime simplement rien. Essayez d'ouvrir un problème ici: Github.com/apigen/apigen/issues J'ai tapé la commande comme PHP Apigen Generate --Help et la sortie est Impossible d'ouvrir le fichier d'entrée: apigen Essayer avec apigen.phar Même Impossible d'ouvrir le fichier d'entrée: apigen.phar

Articles qui pourrait vous intéresser : Pourquoi est-ce que j'obtiens une erreur laravel lors de la création d'un nouveau projet? Select2 ne s'affiche pas correctement dans le mode bootstrap Laravel Echo n'écoute pas La validation de la demande de formulaire ne fonctionne pas. Il charge juste la page d'accueil dans Postman