Warning: file_get_contents(/data/phpspider/zhask/data//catemap/1/php/229.json): failed to open stream: No such file or directory in /data/phpspider/zhask/libs/function.php on line 167

Warning: Invalid argument supplied for foreach() in /data/phpspider/zhask/libs/tag.function.php on line 1116

Notice: Undefined index: in /data/phpspider/zhask/libs/function.php on line 180

Warning: array_chunk() expects parameter 1 to be array, null given in /data/phpspider/zhask/libs/function.php on line 181

Warning: file_get_contents(/data/phpspider/zhask/data//catemap/8/redis/2.json): failed to open stream: No such file or directory in /data/phpspider/zhask/libs/function.php on line 167

Warning: Invalid argument supplied for foreach() in /data/phpspider/zhask/libs/tag.function.php on line 1116

Notice: Undefined index: in /data/phpspider/zhask/libs/function.php on line 180

Warning: array_chunk() expects parameter 1 to be array, null given in /data/phpspider/zhask/libs/function.php on line 181
PHP标准作者标题注释_Php_Header_Comments_Standards - Fatal编程技术网

PHP标准作者标题注释

PHP标准作者标题注释,php,header,comments,standards,Php,Header,Comments,Standards,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 Licen

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
这两个功能是什么?再说一遍,它们是由系统使用的还是纯粹为程序员使用的?

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

phpDocumentor 3.0

由于PEAR head是为PHP4代码而设计的,并对PHP5进行了一些小的更新,因此我认为它更符合当前的标准@package和@category是PEAR在PHP拥有名称空间之前用来分割代码的东西。除非您计划使用PEAR分发代码,否则所有新代码都不应该使用它们。因为其他人已经为PhpDoc提供了链接,所以这是了解可用标记的最好地方。我还想看一看其他主要项目的标签,你在GitHub和其他网站上找到的标签大多使用与最常见标签相似但更新更多的样式。

查看PHPDoc.org标签

语法

@author [name] [<email address>]
@author[name][]
示例

 /**
  * @author My Name
  * @author My Name <my.name@example.com>
  */
/**
*@author我的名字
*@author我的名字
*/

我在函数中使用了这种注释样式

/** * @author Azxster * @datetime 04 March 2020 * @perpose Standard commenting way * @input Get comment requirement * @output Show comment represent the way */ /** *@作者Azzster *@datetime 2020年3月4日 *@perpose标准评论方式 *@input获取评论要求 *@output Show comment表示方式 */
看见它用于以可读的形式编译文档,也可以被大多数ide解析。我可以在Mac上本地安装它并将其与SublimiteText结合使用吗?可能吧,但我对Sublimite并不太熟悉。我使用vim;)