@staticvar

(phpDocumentor 1.1+ )

@staticvar --  document a static variable's use in a function/method

Description

@staticvar datatype description

datatype should be a valid PHP type or "mixed."

phpDocumentor will display the optional description unmodified

Here's an example:

/**
* example of basic @staticvar usage in a function
* @staticvar integer used to calculate the division tables
* @staticvar array $bar is used to make me happy.  Note that $bar is part of the description
* @param bool $baz
* @return mixed
*/
function function1($baz)
{
   static $foo = 6,$bar = array();
   // note that this works as:
   // static $foo = 6;
   // static $bar = array();
   if ($baz)
   {
      $a = 5;
   } else
   {
      $a = array(1,4);
   }
   return $a;
}

Tag Documentation written by Gregory Beaver <cellog@users.sourceforge.net>
Copyright © 2002, Gregory Beaver