PHP标准作者头部注释

Question

我应该使用什么格式来编写 PHP 标头注释？

是否与在此处找到的 PEAR 相同 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 和 @category 这两个是做什么用的？同样，它们是被系统使用还是仅供程序员使用？

- Michael

---

请查看phpdoc。它用于将文档编译成可读的形式，大多数IDE也可以解析它。 - Rob

我能在我的Mac上本地安装它并与Sublime Text一起使用吗？ - Michael

可能吧，但我不太熟悉sublime。我使用vim ;) - Rob

Answer 1

请查看PHPDoc文档。它包含所有标签的解释。

phpDocumentor 3.0
https://docs.phpdoc.org/3.0/guide/references/phpdoc/tags/index.html

- Chokchai

Answer 2

查看 PHPDoc.org 的 @author 标签。

语法

@author [name] [<email address>]

例子

 /**
  * @author My Name
  * @author My Name <[e-mail]>
  */

- Faisal

Answer 3

由于PEAR head是为PHP4代码制作的，并进行了小型更新以使其与PHP5兼容，因此我会寻找更符合当前标准的东西。@package和@category是PEAR在PHP没有命名空间之前用来分割代码的东西。除非您计划使用PEAR来发布您的代码，否则所有新代码都不应使用它们。由于其他人已经提供了PhpDoc的链接，因此这是学习可用标记的最佳位置。我还会查看其他主要项目使用的标记，这些项目可以在GitHub和其他网站上找到，大多数使用类似但更更新的样式，其中包括最常见的标记。

- Dragonaire

Answer 4

我使用这个函数的注释风格

/**
* @author     Azxster
* @datetime   2020年3月4日
* @purpose    标准注释方式
* @input      获取注释要求
* @output     显示注释呈现方式
*/

- Azxster

---

也许拼写@purpose正确一点 =) - secondman