PHP format Commentaire: généré automatiquement ou créées par l'utilisateur?

Question

J'ai toujours vu ces commentaires d'en-tête en php, et je me demandais souvent si un logiciel a été utilisé pour les mettre en place? Je semble rappeler JavaDoc ou quelque chose? Mais je ne suis pas sûr si cela est généré automatiquement? Ou est-ce juste un type de documentation standard?

L'exemple ci-dessous est de CodeIgniter:

/** 
* CodeIgniter 
* 
* An open source application development framework for PHP 4.3.2 or newer 
* 
* @package  CodeIgniter 
* @author  ExpressionEngine Dev Team 
* @copyright Copyright (c) 2008, EllisLab, Inc. 
* @license  http://codeigniter.com/user_guide/license.html 
* @link  http://codeigniter.com 
* @since  Version 1.0 
* @filesource 
*/ 

Je voudrais vraiment améliorer mon commentaire et je pense que ce serait une excellente forme pour mes projets.

Answer 1

Il est phpDoc qui est utilisé par certains cadres avec la réflexion pour comprendre et utiliser les classes dynamiquement (par le code lui-même). Les EDI l'utiliseront également pour la saisie semi-automatique, l'affichage des arguments de fonction, etc. Bonne chose à savoir si votre EDI fournit ces fonctions pour le Framework que vous utilisez, mais pas le code que vous écrivez.

PHP's Reflection API

Zend Framework Extension (including DocBlocks)

CodeIgniter's Comment Guide (Using DocBlock '...so they can be picked up by IDEs')

DocBlock Description on phpdoc.org (linked from CI's Style Guide)

Answer 2

Ceci est JavaDoc et il est probablement générée automatiquement par un IDE.

Answer 3

Certains IDE peuvent le mettre automatiquement, mais les gens souvent il suffit de taper dans.

Pour PHP, il est PHP Documentor, vous peut voir un quickstart guide here.

Ceci va scanner votre code source et créer une documentation basée sur vos commentaires sur vos fichiers, classes et fonctions.

Answer 4

Ces commentaires suivent la norme phpdoc et peuvent être utilisés pour générer automatiquement une documentation pour votre code. Vous pouvez voir un exemple d'une telle documentation here.

Alors que certains IDE ont du support pour faciliter leur écriture, le contenu réel est manuscrit par les programmeurs.