php - 本文档注释在 PHP 中是什么或如何使用

Question

我经常看到这类有据可查的评论。

/*
* @author      some name
* @category    Core
* @package     /dir/name
* @version     1.6.4
*/

function ... (){}

*** code here ***

我想知道因为有这么多人在使用它（大多数开源）

它们是什么以及我如何使用这种方法或了解更多关于这种东西的信息。

我不是在寻找一个快速的答案，这里做你的研究：

希望有一个有用的答案，解释它是什么，花时间编写额外代码有什么好处等等......

score 3 · Accepted Answer

它们是 PHP 文件注释中的文档标记。常用于生成文档的应用程序，例如PHP Documentator

从介绍：

phpDocumentor 2 是一个可以从 PHP 源代码生成文档的工具。使用此文档，您可以为您的消费者提供有关源中嵌入的功能的更多信息，而不仅仅是您的用户界面中对他们可用的功能。

score 0 · Accepted Answer

它们被称为注释，通常（但不仅）用于文档目的。尝试阅读：http ://en.wikipedia.org/wiki/PHPDoc

2 回答 2