phpDocumentor

phpDocumentor est parfois appelé phpdoc ou phpdocu.
Similaire à Javadoc et RDoc, il est écrit en PHP et peut être utilisé à partir de la ligne de commande ou une interface web pour créer des documents professionnels à partir du code source PHP

Caractéristiques :.

• Sortie en HTML, PDF (directement), CHM (avec des fenêtres compilateur d'aide), XML DocBook
• Très rapide
• Web et l'interface de ligne de commande
• sortie Entièrement personnalisable avec des modèles basés sur Smarty
• Reconnaît la documentation JavaDoc de style
• Le lien automatique, des diagrammes d'héritage de classe et intelligente override
• personnalisable code source mise en évidence, avec phpxref style renvois
• Analyse les README / changelog / install / FAQ fichiers standard et les inclut directement dans la documentation
• Génère une liste de tâches à partir d'étiquettes detodo dans la source
• génère plusieurs ensembles de documentation basé suraccess privé,internal et {}internal balises
• Exemple fichiers PHP peuvent être placés directement dans la documentation avec évidence et phpxref reliant utilisant la baliseexample
• Liaison entre manuel externe et de la documentation de l'API est possible au niveau sous-section dans tous les formats de sortie
• facilement étendue pour la documentation des besoins spécifiques avec Converter
• Une documentation complète de chaque fonction, manuel peut être généré directement à partir du code source avec & quot; phpdoc -c makedocs & quot; dans chaque format désiré.
• Utilisateur fichiers .ini peuvent être utilisés pour contrôler la sortie, plusieurs sorties peuvent être générés à la fois.

Ce qui est nouveau dans cette version:

• AJOUTEE:
• Information comment faire un don à phpDocumentor utilisant gittip
• processus d'information et de profilage
• CHANGÉ:
• Proposé le code de documentation de la classe externe à leur propre routeur
• Remplacé dépendance MarkDownExtra avec Parsedown
• Réécriture de beaucoup de la documentation; encore un travail en cours
• FIXE:
• documentation de classe externes avaient ../files préfixé

Balises
• Todo ne se présentent pas dans les modèles Twig
• Arguments passés par référence ne se présentent pas comme étant en référence
• Empêcher sortie de l'emballage dans la console Windows
• Code Nettoyé basée sur les messages d'intégration continue
• problèmes de fuseau horaire sur certaines machines
• Divers problèmes dans plusieurs modèles

Ce qui est nouveau dans la version 2.0.1:

• FIXE:
• fichiers phar générés ne peuvent pas être mis à l'exécutable et ont couru.
• absents docblocks de niveau fichier ne sont pas détectés.
• Classes et namespace ne sont pas générés dans Windows.
• Des avis ont été jetés avec le modèle Clean.
• Dans les fenêtres chemins ont été calculés de manière incorrecte.