Last active
August 29, 2015 14:07
-
-
Save mbeall/66a504940f55d16a24d1 to your computer and use it in GitHub Desktop.
DocBlock Templates
This file contains 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
| /** | |
| * A summary informing the user what the associated element does. | |
| * | |
| * A *description*, that can span multiple lines, to go _in-depth_ into the details of this element | |
| * and to provide some background information or textual references. | |
| * | |
| * @author | |
| * @deprecated | |
| * @since | |
| * | |
| * @method | |
| * @uses | |
| * | |
| * @see | |
| * | |
| * @todo | |
| */ |
This file contains 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
| /** | |
| * A summary informing the user what the associated element does. | |
| * | |
| * A *description*, that can span multiple lines, to go _in-depth_ into the details of this element | |
| * and to provide some background information or textual references. | |
| * | |
| * @author | |
| * @copyright | |
| * @license | |
| * @package | |
| * @version | |
| * | |
| * @todo | |
| */ |
This file contains 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
| /** | |
| * A summary informing the user what the associated element does. | |
| * | |
| * A *description*, that can span multiple lines, to go _in-depth_ into the details of this element | |
| * and to provide some background information or textual references. | |
| * | |
| * @author | |
| * @deprecated | |
| * @since | |
| * | |
| * @method | |
| * @uses | |
| * @throws | |
| * | |
| * @param | |
| * @return | |
| * @var | |
| * | |
| * @example | |
| * @see | |
| * | |
| * @todo | |
| */ |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment