Phpdocumentor Comment Syntax

Source: Internet
Author: User

Phpdocumentor is a powerful code comment generator, which is a simple summary of each parameter:

@abstract
-------------
Use the @abstract tag to declare a method that a class variable or class must redefine in a subclass that is valid.

@abstract
-------------
Use the @abstract tag to declare a method, a class variable, or a class that is abstract.
In a class, as long as there is an abstract method, the class must be declared as an abstract class.
An abstract method must be overridden in a subclass.
Abstract classes cannot be overridden after they are inherited by an abstract method.

@access
-------------
Access rights public, protected, private

@author
-------------
Author

@category
-------------
Classification, e.g. (Library,helper,view, etc.)

@copyright
-------------
Copyright

@deprecated
-------------
Obsolete, about to be discarded

@example
-------------
Include external sample files with syntax highlighting

@final
-------------
The final class cannot be inherited, and the final method cannot be overridden

@filesource
-------------
Creates a referenced file source code that contains the current file and links, syntax highlighting

@global
-------------
Global variables

@ignore
-------------
Use @ignore to prevent document-logged elements, such as duplicate elements.

@internal
-------------
Mark as private, inside the software project

@license
-------------
Hyperlinks to license files

@link
-------------
Hypertext links

@method
-------------
A "magic" method for a class

@name
-------------
Phpdocumentor identifies the @name tag in the global variable (combined with @global) and uses it to rename a document's global variable to enhance readability. A global variable must start with ($), otherwise phpdocumentor will ignore the tag and error.

@package
-------------
Specifies the package to organize classes or methods. @package can only be used for document program pages or classes.

@param
-------------
Parameters of the function

@property
-------------
"Magic" Property

@return
-------------
Specifies the return value type of a function or method

@see
-------------
Links to documents that point to elements

@since
-------------
from which version to start adding it into the package

@static
-------------
Static properties or methods that can be called without instantiation

@staticvar
-------------
Static variables in a function or method

@subpackage
-------------
organize PHP files together with @package for documents

@todo
-------------
There may be changes in the future

@tutorial
-------------
Show a tutorial that points to the file

@uses
-------------
Displays a link to the element's document and creates a backlink document in the other element

@var
-------------
Variable

@version
-------------
Version

Transferred from: www.zf-bbs.com

Phpdocumentor Comment Syntax

Contact Us

The content source of this page is from Internet, which doesn't represent Alibaba Cloud's opinion; products and services mentioned on that page don't have any relationship with Alibaba Cloud. If the content of the page makes you feel confusing, please write us an email, we will handle the problem within 5 days after receiving your email.

If you find any instances of plagiarism from the community, please send an email to: info-contact@alibabacloud.com and provide relevant evidence. A staff member will contact you within 5 working days.

A Free Trial That Lets You Build Big!

Start building with 50+ products and up to 12 months usage for Elastic Compute Service

  • Sales Support

    1 on 1 presale consultation

  • After-Sales Support

    24/7 Technical Support 6 Free Tickets per Quarter Faster Response

  • Alibaba Cloud offers highly flexible support services tailored to meet your exact needs.