2016-04-25 1 views
-4

enter image description hereLa meilleure façon d'écrire en-tête de contributions en php et tous les tags disponibles comme @author

Je travaille sur un projet GitHub https://github.com/qzoke/isbn-converter Je veux créer une belle tête de contribution. Donc, voici mes questions:

  1. Toutes les variables ou quelque chose comme @author disponible.

peu que je sais sont:

@author 
@license 
@version 
@package 
@subpackage 
  1. La meilleure façon de mettre en valeur des valeurs telles que

peu de gens utilisent

@author www.website.com 

quelques utiliser

@author name<email> 

et certains juste

@author name. 
  1. Comment et ce qui devrait être le nom pour le paquet et le paquet sous. le sous-paquetage est confus, aucune idée si je devrais utiliser le nom de fichier dans le sous-paquet ou le même nom de paquet.

  2. Est-il correct d'écrire la description, mot-clé, contribution par là. Quelle est la meilleure façon de faire référence à la licence, juste le nom (comme GNU GPL v3.0) ou le nom + weblink ou un lien vers une copie locale ou une copie du texte complet de la licence.

  3. Et quels fichiers devraient avoir un tel en-tête, juste index.php, ou header.php ou tous les autres.

  4. Et ce qu'il faut inclure dans les commentaires html, le cas échéant.

+0

Comment cette obtenir -5 points en 3 minutes? Ce n'est pas * que * terrible d'une question ... –

+2

@MattiVirkkunen Semble être un ensemble de questions, dont aucune n'a aucune indication que le demandeur a essayé de faire des progrès. – Richard

+0

Ouais mais -5? Comment cela se produit même –

Répondre

1

Selon la documentation https://phpdoc.org/ il y a un certain nombre de balises reconnues par le phpDocumentor figurant à https://phpdoc.org/docs/latest/index.html.

Exemple de source https://phpdoc.org/docs/latest/references/phpdoc/tags/author.html

Syntax: @author [name] [<email address>]

La balise @author peut être utilisé pour indiquer qui a créé éléments de structure ou a fait des modifications importantes à leur disposition. Cette balise PEUT également contenir une adresse e-mail. Si une adresse e-mail est fournie, elle DOIT suivre le nom de l'auteur et être contenue dans des chevrons, ou des chevrons, et DOIT respecter la syntaxe définie dans la section 3.4.1 de la RFC5322.

Tous vos points peuvent être répondus en utilisant la documentation de PHPDoc.

Peu plus Tags PHPDoc sont:

@abstract 
@access 
@author 
@copyright 
@deprecated 
@deprec 
@example 
@exception 
@global 
@ignore 
@internal 
@license 
@link 
@name 
@magic 
@package 
@param 
@return 
@see 
@since 
@static 
@staticvar 
@subpackage 
@throws 
@todo 
@var 
@version 

Vous pouvez trouver plus https://en.wikipedia.org/wiki/PHPDoc