Documentation of Functions

Documentation of functions enable programmers to determine which functions are available, the expected parameters, and what they will return.

The @param tag is used for variables, and to declare the parameters of the function, the suggested type, and a description. When used in a function documentation comment, the @type tag declares the typical return type of the function. A function documentation comment must be placed immediately before the function declaration. An example of a documentation comment for a function is provided in Documentation Comments.