14

我应该为 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这两个做什么？再一次，它们是由系统使用还是纯粹为程序员使用？

4

4 回答 4

10

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

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

于 2013-10-02T05:45:54.837 回答
5

查看 PHPDoc.org @author标记。

句法

@author [name] [<email address>]

例子

 /**
  * @author My Name
  * @author My Name <my.name@example.com>
  */
于 2016-12-20T07:57:56.060 回答
1

由于 PEAR 头是为 PHP4 代码制作的，并带有与 PHP5 一起使用的小更新，所以我看起来更符合当前标准。@package 和 @category 是 PEAR 在 PHP 有命名空间之前用来分割代码的东西。除非您打算使用 PEAR 来分发您的代码，否则所有新代码都不应使用它们。由于其他人已经提供了 PhpDoc 的链接，因此它是了解可用标签的最佳场所。我还会看一下您在 GitHub 和其他网站上找到的其他主要项目使用的标签，因为大多数项目使用最常见的标签的类似但更新的样式。

于 2014-06-06T16:00:34.567 回答
0

我将这种注释样式用于功能

/**
* @作者阿兹斯特
* @datetime 2020 年 3 月 4 日
* @perpose 标准评论方式
* @input 获取评论需求
* @output 显示评论代表方式
*/
于 2020-03-04T07:36:12.153 回答