Created
February 6, 2014 12:31
-
-
Save pherrymason/8843267 to your computer and use it in GitHub Desktop.
PHP DOC tags
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| /** | |
| * The short description | |
| * | |
| * As many lines of extendend description as you want {@link element} links to an element | |
| * {@link http://www.example.com Example hyperlink inline link} links to a website | |
| * Below this goes the tags to further describe element you are documenting | |
| * | |
| * @param type $varname description | |
| * @return type description | |
| * @access public or private | |
| * @author author name | |
| * @copyright name date | |
| * @version version | |
| * @see name of another element that can be documented, produces a link to it in the documentation | |
| * @link a url | |
| * @since a version or a date | |
| * @deprecated description | |
| * @deprec alias for deprecated | |
| * @magic phpdoc.de compatibility | |
| * @todo phpdoc.de compatibility | |
| * @exception Javadoc-compatible, use as needed | |
| * @throws Javadoc-compatible, use as needed | |
| * @var type a data type for a class variable | |
| * @package package name | |
| * @subpackage sub package name, groupings inside of a project | |
| */ | |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment