PHP Standardowy autor nagłówek komentarze

Question

Jaki format powinienem użyć do komentarzy nagłówka PHP?

Czy to samo dla PEAR jak znaleźć tutaj http://pear.php.net/manual/en/standards.header.php?

Co powinno być zawarte?

<?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 
*/ 

?> 

Czy ktoś mógłby wyjaśnić, co każdy z nich oznacza inaczej niż autor i prawa autorskie.

Czy wprowadzając numer wersji tutaj nic innego niż pokazać programista? Czy może być używany przez sam system?

@package i @category Co te dwa zrobić? I znowu, czy są używane przez system, czy jest to wyłącznie programista?

Answer 1

Zapoznaj się z dokumentacją PHPDoc. Zawiera objaśnienia wszystkich tagów.

https://phpdoc.org/docs/latest/index.html

Answer 2

Ponieważ głowica PEAR powstał dla kodu PHP4 z małymi aktualizacjach pracy z PHP5 będę wyglądać jak coś więcej zgodne z obowiązującymi normami. @package i @category były czymś, co PEAR używał do podziału kodu zanim PHP miało przestrzenie nazw. Cały nowy kod nie powinien ich używać, chyba że planujesz użyć PEAR do dystrybucji swojego kodu. Ponieważ ktoś już daje link do PhpDoc, jest to najlepsze miejsce do poznania dostępnych tagów. Chciałbym również rzucić okiem na znaczniki innych dużych projektów, które można znaleźć na GitHub i innych witrynach, ponieważ większość używa podobnych, ale bardziej zaktualizowanych stylów z najbardziej typowymi tagami.

Answer 3

Zapoznaj się z PHPDoc.org @author tag.

Składnia

@author [name] [<email address>] 

Przykłady

/** 
    * @author My Name 
    * @author My Name <my.name@example.com> 
    */