PHP Standard de l'auteur commentaires d'en-tête
Quel est le format que je devrais utiliser pour PHP commentaires d'en-tête?
Est-ce le même pour les POIRES, comme l'a constaté ici http://pear.php.net/manual/en/standards.header.php?
Ce qui devrait être contenue?
<?php
/**
* database.php
*
* Database access
*
* @category CategoryName
* @package PackageName
* @author Mike
* @copyright 2013 Mike
* @license http://www.php.net/license/3_0.txt PHP License 3.0
* @version CVS: $Id:$
* @link http://pear.php.net/package/PackageName
* @see NetOther, Net_Sample::Net_Sample()
* @since File available since Release 1.2.0
* @deprecated File deprecated in Release 2.0.0
*/
?>
Quelqu'un pourrait-il expliquer ce que chacun de ces effectivement dire d'autres que l'auteur et de droits d'auteur.
N'entrant le numéro de version ici rien faire d'autre que de montrer le programmeur? Peut-il être utilisé par le système lui-même?
@package
et @category
Que faire de ces deux-là? Et encore, sont-ils utilisés par le système ou est-ce purement pour le programmeur?
Voir phpdoc. Il est utilisé pour recueillir de la documentation dans une forme lisible et peut également être analysé par la plupart des ide.
Puis-je installer ce local sur mon Mac et de l'utiliser en conjonction avec SUblimeText?
Sans doute, mais je ne suis pas vraiment familier avec le sublime. J'utilise vim 😉
Puis-je installer ce local sur mon Mac et de l'utiliser en conjonction avec SUblimeText?
Sans doute, mais je ne suis pas vraiment familier avec le sublime. J'utilise vim 😉
OriginalL'auteur Mike | 2013-10-02
Vous devez vous connecter pour publier un commentaire.
Découvrez la PHPDoc de la documentation. Il contient des explications sur toutes les balises.
https://phpdoc.org/docs/latest/index.html
Il est maintenant en ligne.
OriginalL'auteur Chokchai
Découvrez l'PHPDoc.org @l'auteur tag.
Syntaxe
Exemples
OriginalL'auteur Faisal
Depuis la POIRE de la tête a été faite pour PHP4 code avec de petites mises à jour pour fonctionner avec PHP5 j'aurais l'air comme quelque chose de plus, en conformité avec les normes actuelles. @package et @catégorie ont été quelque chose qui de POIRE utilisée pour séparer le code avant de PHP a des espaces de noms. Tous les nouveaux code ne devrait pas les utiliser sauf si vous prévoyez d'utiliser la POIRE de distribution de votre code. Comme quelqu'un d'autre est déjà donner le lien pour PhpDoc, c'est le meilleur endroit pour en apprendre davantage sur les étiquettes. Je voudrais aussi prendre un regard sur les balises d'autres grands projets que vous trouvez sur GitHub et les autres sites comme la plupart des utilisations similaires, mais plus de mise à jour des styles avec des balises les plus couramment utilisées.
OriginalL'auteur Dragonaire