PHP experience--phpdoc standard documentation for PHP annotations (translated from wiki)

Source: Internet
Author: User

Mark Use Description
@abstract Variables and methods for abstract classes
@access Public, private or protected Access and use permissions for the document. @access private indicates that the document is protected.
@author Zhang San <[email protected]> Document author
@copyright Name time Document copyright information
@deprecated Version Methods that are abolished in the document
@deprec Same @deprecated
@example /path/to/example The location of the sample file that is saved externally to the document.
@exception Exceptions that are thrown by methods in the document can also be referenced @throws.
@global Type: $globalvarname Global variables and related methods and functions in a document
@ignore Ignore keywords specified in the document
@internal Development team Internal Information
@link Url Similar to license but you can also find more detailed information in a document by link
@name Variable aliases Assign an alias to a variable
@magic phpdoc.de compatibility
@package The name of the package package A set of related classes, package names encapsulated by functions
@param such as [$username] User name Variable meaning comment
@return If you return bool function returns the result description, generally not in the function of void (empty return result)
@see such as Class Login () Any element associated with the file (global variables, including, pages, classes, functions, definitions, methods, variables).
@since Version Record when changes are made to which parts of the document
@static Record static classes, methods
@staticvar Static variables used in classes, functions
@subpackage Child version
@throws Exception thrown by a method
@todo Indicates that the file has not been completed or is to be perfected
@var Type Variables and their types in the document
@version Version information for documents, classes, functions

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.