at sign in function headers

carlwenrich

What is the significance of the at sign in front of parameters documented in function headers?

laserlight

Any examples? The @ operator is the error suppression operator, so if it is used, it would be when calling the function, not when defining them (except in the implementation of the function itself).

That said, I recommend not suppressing errors with @, but setting display_errors to off in php.ini and logging errors instead.

carlwenrich

/**

Element

*
Lets you determine whether an array index is set and whether it has a value.
If the element is empty it returns FALSE (or whatever you specify as the default value.)

*
@access public
@ string
@ array
@ mixed
@return mixed depends on what the array contains

*/

if ( ! function_exists('element'))

{

function element($item, $array, $default = FALSE)

{

	if ( ! isset($array[$item]) OR $array[$item] == "")

	{

		return $default;

	}



	return $array[$item];

}

}

laserlight

Oh, that looks like a Javadoc style comment, e.g., that used in PHP Documentor. It has no real meaning in PHP itself.

carlwenrich

thanks

NogDog

See www.phpdoc.org for more info.