Prev | Next |
Tag Documentation written by [email protected]Copyright 2002, Gregory Beaver
NOTE: as of 0.4.1, @param can document phpdoc.de-style, with optional $paramname
The datatype should be a valid PHP type (int, string, bool, etc), a class name for the type of object, or simply "mixed". Further, you can list multiple datatypes for a single parameter by delimiting them with the pipe (e.g. "@param int|string $p1"). You may document parameters listed or any optional paramters that will be parsed by standard PHP functions func_num_args()/get_func_arg(). Recommended name format for parameters listed with func_get_arg() is:
$paramname if there is only one parameter
$paramname,... if the number of parameters is unlimited
phpDocumentor will display the optional description unmodified.
Note that the $paramname,... will be shown in the output docs in both the parameter listing AND the function signature. If you are not indicating in the actual code that the parameter is optional (via "$paramname = 'a default value'"), then you should mention in the parameter's description that the parameter is optional.
Here's an example:
Prev | Up | Next |
@package | phpDocumentor tags | @property |