PHP中使用的文档注释是什么或如何

时间:2013-03-21 15:02:48

标签: php comments

我经常看到这种类型的评论已有详细记录。

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

function ... (){}

*** code here ***

我想知道很多人都在使用这个(大多数开源)

他们是什么以及我如何使用这种方法或了解更多有关此类内容的信息。

我不是在寻找快速答案,在这里做你的研究:

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

2 个答案:

答案 0 :(得分:3)

它们是PHP文件注释中的文档标记。通常用于生成PHP Documentator

等文档的应用程序

来自简介:

  

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

答案 1 :(得分:0)

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