Question

我应该为PHP标题注释使用什么格式？

这是否与此处http://pear.php.net/manual/en/standards.header.php中的PEAR相同？

应该包含什么？

<?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和@category这两个人做了什么？再次，它们是由系统使用还是仅供程序员使用？

Answer 1

查看PHPDoc文档。它包含所有标签的说明。

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

Answer 2

查看PHPDoc.org @author标记。

<强>语法

@author [name] [<email address>]

<强>实施例

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

Answer 3

由于PEAR头是为PHP4代码制作的，只需要很少的更新就可以使用PHP5，我认为它更像是符合现行标准。 @package和@category是PE在用于命名空间之前用于分割代码的东西。除非您计划使用PEAR来发布代码，否则所有新代码都不应使用它们。由于其他人已经为PhpDoc提供了链接，因此它是了解可用标签的最佳位置。我还要看一下你在GitHub和其他网站上使用的其他主要项目的标签，因为大多数使用类似但更新的样式和最常见的标签。

Answer 4

我将此注释样式用于功能

/**
* @author     Azxster
* @datetime   04 March 2020
* @perpose    Standard commenting way
* @input      Get comment requirement
* @output     Show comment represent the way
*/

PHP标准作者标题评论

4 个答案: