PhpDOC comments usage

Source: Internet
Author: User
PhpDOC type comment usage ** @ name * @ abstract declarative variable class method * @ access specifies the access permission for this variable, class, and function method * @ author function author's name and email address * @ category organization packages * @ copyright indicates the copyright information * @ const indicates the constant * @ depreca php DOC type comment usage
/*** @ Name ** @ abstract declarative variable/class/method * @ access specifies the access permission for this variable, class, function/method * @ author function author's name and email address address * @ category organization packages * @ copyright indicates the copyright information * @ const indicates the constant * @ deprecate indicates the information not recommended or discarded * @ example * @ exclude indicates that the current comment will not for analysis, not included in the document * @ final indicates that this is a final class, method, and attribute, and cannot be derived or modified. * @ Global indicates the global variable referenced in this function * @ include indicates the information of the contained files * @ link defines the online connection * @ module defines the module information of the attribution * @ modulegroup defines the attribution module group * @ package defines the information of the owner package * @ param defines the function or method parameter information * @ return defines the returned information of the function or method * @ see defines the function to be referenced, variable, and add the corresponding Super connection. * @ Since indicates the version from which the api function or method is introduced * @ static indicates that the variables, classes, and functions are static. * @ Throws indicates the error exception that this function may throw. in extreme cases, * @ todo indicates the areas to be improved or not implemented * @ var defines variables/attributes. * @ Version defines version information */

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.