| A built-in template for PHP function doc comment. |
| Predefined variables will take the following values: | ||
| Function name. | ||
| A type hint of the function's return value. If no return types can be found from function static analysis, evaluates to "void". | ||
|
Parameters' doc comment. Generated as a number of lines '* @param type name". If there are no parameters, evaluates to an empty content. |
||
|
Exceptions' doc comment. Generated as a number of lines '* @throws type". If there are no thrown exceptions, evaluates to an empty content. |
||
Takes a value of "static" if the function (method) is static or an empty string
otherwise. For example:
#if (${STATIC} == "static") * @static
#end
|
||
|
|
Dollar sign, evaluates to a plain '$' character. | |
|
|
current system date | |
|
|
current system time | |
| current year | ||
| current month | ||
| first 3 letters of the current month name. Example: Jan, Feb, etc. | ||
| full name of the current month. Example: January, February, etc. | ||
| current day of the month | ||
| current hour | ||
| current minute | ||
| current second | ||
| the name of the current project | ||
| current user | ||
|
|
Marks a position where the caret must be moved after the comment is added. | |