PHP標準作者標題評論

Question

我應該使用什麼格式的PHP標題評論？

這是否與在這裏找到的http://pear.php.net/manual/en/standards.header.php相同？

應該包含什麼？

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

?> 

有人能解釋一下，除了作者和版權以外，這些實際上是什麼意思。

在此處輸入版本號是否可以執行除了顯示程序員之外的其他任何內容？它可以被系統本身使用嗎？

@package and @category這兩個做什麼？而且，它們是被系統使用還是純粹是程序員？

Answer 1

查看PHPDoc文檔。它包含所有標籤的解釋。

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

Answer 2

由於梨花頭是爲PHP4代碼所做的小更新與PHP5工作，我想看看的東西更符合現行標準。在PHP有名稱空間之前，@package和@category是PEAR用來分割代碼的東西。除非您打算使用PEAR來發布您的代碼，否則所有新代碼都不應使用它們。由於其他人已經爲PhpDoc提供鏈接，因此它是瞭解可用標籤的最佳位置。我還會看看標籤上的其他主要項目，您在GitHub和其他網站上使用的大多數項目都使用類似但更新的樣式和最常見的標籤。

Answer 3

查看PHPDoc.org @author標記。

語法

@author [name] [<email address>] 

實例

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