What is the purpose of these PHPDOC properties?

Question

In general, the properties of PHPDOC are self-explanatory, but it's hard for me to understand them:

@category - what exactly is it?

@package - can someone give me examples about using this property?

Answer 1

A package tag is an organization tag that you use in your code. When phpDocumentor generates documents, it collects items into packages you have installed. In some cases, you can use only one package name (@package MyPackage) for your entire code base, so that all files, classes, etc. Displayed in these package documents.

, , - (@package Webpages), , (@package DatabaseHandlers), (@package Utilites), .

, @package, , ... , . , , , , , , , "" , ... , - , , phpDocumentor .

, , - , , PEAR. . , PEAR, . , ... , , phpDocumentor .

, @package, , . , ( , "" ) . , phpDocumentor .

... , @package, -dn runtime [1]. phpDocumentor , "" , . -dc , , phpDocumentor.

[1] - http://manual.phpdoc.org/HTMLSmartyConverter/HandS/phpDocumentor/tutorial_phpDocumentor.howto.pkg.html#using.command-line.defaultpackagename

( URL-, stackoverflow ...)

Answer 2

@category

@category .

XML: DocBook/peardoc2 . , phpDocumentor , . -dc, --defaultcategoryname

http://manual.phpdoc.org/HTMLSmartyConverter/HandS/phpDocumentor/tutorial_tags.category.pkg.html

@package

@package .

, . , phpDocumentor (, ) " ". , .

http://manual.phpdoc.org/HTMLSmartyConverter/HandS/phpDocumentor/tutorial_tags.package.pkg.html