PHPDocument 注释实例
匿名 · 更新于 2014/9/24
你会写注释么？从我写代码开始，这个问题就一直困扰着我，相信也同样困扰着其他同学。以前的写注释总是没有一套行之有效的标准，给维护和协同开发带了许多麻烦，直到最近读到了phpdocumentor的注释标准。
下面对phpdocumentor的注释标准进行总结：
Type（数据类型）:
- string 字符串类型
- integer or int 整型
- boolean or bool 布尔类型 true or false
- float or double 浮点类型
- object 对象
- mixed 混合类型 没有指定类型或不确定类型时使用
- array 数组
- resource 资源类型 （如数据库查询返回）
- void 空值（控制器返回值经常使用）
- null null类型
- callable 回调函数
- false or true 只返回true or fasle 时使用
- self 自身
<p>Tags（标签）:</p> <p lang="en-US"> </p> <table border="1" cellpadding="0" cellspacing="0" valign="top"> <tbody> <tr> <td> <p>Tag</p> </td> <td> <p>Element</p> </td> <td> <p>Description</p> </td> </tr> <tr> <td> <p>api</p> </td> <td> <p>Methods</p> </td> <td> <p>声明接口</p> </td> </tr> <tr> <td> <p>author</p> </td> <td> <p>Any</p> </td> <td> <p>作者信息</p> </td> </tr> <tr> <td> <p>category</p> </td> <td> <p>File, Class</p> </td> <td> <p>将一系列的元素分类在一起</p> </td> </tr> <tr> <td> <p>copyright</p> </td> <td> <p>Any</p> </td> <td> <p>版权信息</p> </td> </tr> <tr> <td> <p>deprecated</p> </td> <td> <p>Any</p> </td> <td> <p>声明元素已被弃用,可以在将来的版本中删除</p> </td> </tr> <tr> <td> <p>example</p> </td> <td> <p>Any</p> </td> <td> <p>示例</p> </td> </tr> <tr> <td> <p>filesource</p> </td> <td> <p>File</p> </td> <td> <p>文件资源</p> </td> </tr> <tr> <td> <p>global</p> </td> <td> <p>Variable</p> </td> <td> <p>声明一个全集变量</p> </td> </tr> <tr> <td> <p>ignore</p> </td> <td> <p>Any</p> </td> <td> <p>忽略当前元素 （phpdocumentor 生成文档时）</p> </td> </tr> <tr> <td> <p>internal</p> </td> <td> <p>Any</p> </td> <td> <p>声明一个值为整形，或者设置一个应用的默认值为整型</p> </td> </tr> <tr> <td> <p>license</p> </td> <td> <p>File, Class</p> </td> <td> <p>声明许可类型</p> </td> </tr> <tr> <td> <p>link</p> </td> <td> <p>Any</p> </td> <td> <p>声明一个和当前元素有关的链接</p> </td> </tr> <tr> <td> <p>method</p> </td> <td> <p>Class</p> </td> <td> <p>声明当前类那些魔术方法可以被调用</p> </td> </tr> <tr> <td> <p>package</p> </td> <td> <p>File, Class</p> </td> <td> <p>声明当前元素所属的包</p> </td> </tr> <tr> <td> <p>param</p> </td> <td> <p>Method, Function</p> </td> <td> <p>声明当前元素的一个参数</p> </td> </tr> <tr> <td> <p>property</p> </td> <td> <p>Class</p> </td> <td> <p>声明当前类有那些魔术方法可以被调用属性</p> </td> </tr> <tr> <td> <p>property-read</p> </td> <td> <p>Class</p> </td> <td> <p>声明当前类有那些魔术方法可以读取属性</p> </td> </tr> <tr> <td> <p>property-write</p> </td> <td> <p>Class</p> </td> <td> <p>声明当前类有那些魔术方法可以设置属性</p> </td> </tr> <tr> <td> <p>return</p> </td> <td> <p>Method, Function</p> </td> <td> <p>返回值</p> </td> </tr> <tr> <td> <p>see</p> </td> <td> <p>Any</p> </td> <td> <p>说明当前元素参数引用于其他站点或元素</p> </td> </tr> <tr> <td> <p>since</p> </td> <td> <p>Any</p> </td> <td> <p>声明当前元素始于于哪个版本</p> </td> </tr> <tr> <td> <p>source</p> </td> <td> <p>Any, except File</p> </td> <td> <p>展示当前元素的<a class="keylink" href="http://www.2cto.com/ym" target="_blank">源码</a></p> </td> </tr> <tr> <td> <p>subpackage</p> </td> <td> <p>File, Class</p> </td> <td> <p>将当期元素分类</p> </td> </tr> <tr> <td> <p>throws</p> </td> <td> <p>Method, Function</p> </td> <td> <p>说明当前元素抛出的异常</p> </td> </tr> <tr> <td> <p>todo</p> </td> <td> <p>Any</p> </td> <td> <p>说明当前元素的开发活动</p> </td> </tr> <tr> <td> <p>uses</p> </td> <td> <p>Any</p> </td> <td> <p>引用一个关联元素</p> </td> </tr> <tr> <td> <p>var</p> </td> <td> <p>Properties</p> </td> <td> <p>声明属性</p> </td> </tr> <tr> <td> <p>version</p> </td> <td> <p>Any</p> </td> <td> <p>版本</p> </td> </tr> </tbody> </table> <p> </p> <p> </p> <p>Example（示例）：</p> <p> </p> <p lang="en-US">// =============================</p> <p lang="en-US"> </p> <p lang="en-US">@api</p> <p lang="en-US"> </p> <p> </p> <div> <div class="syntaxhighlighter java" id="highlighter_867840"> <div class="toolbar"><span><a class="toolbar_item command_help help" href="http://www.2cto.com/kf/201408/322110.html#">?</a></span></div> <table border="0" cellpadding="0" cellspacing="0"> <tbody> <tr> <td class="gutter"> <div class="line number1 index0 alt2">1</div> <div class="line number2 index1 alt1">2</div> <div class="line number3 index2 alt2">3</div> <div class="line number4 index3 alt1">4</div> <div class="line number5 index4 alt2">5</div> <div class="line number6 index5 alt1">6</div> <div class="line number7 index6 alt2">7</div> <div class="line number8 index7 alt1">8</div> <div class="line number9 index8 alt2">9</div> <div class="line number10 index9 alt1">10</div> <div class="line number11 index10 alt2">11</div> </td> <td class="code"> <div class="container"> <div class="line number1 index0 alt2"><code class="java preprocessor">/**</code></div> <div class="line number2 index1 alt1"><code class="java spaces"> </code><code class="java preprocessor">* This method will not change until a major release.</code></div> <div class="line number3 index2 alt2"><code class="java spaces"> </code><code class="java preprocessor">*</code></div> <div class="line number4 index3 alt1"><code class="java spaces"> </code><code class="java preprocessor">* @api</code></div> <div class="line number5 index4 alt2"><code class="java spaces"> </code><code class="java preprocessor">*</code></div> <div class="line number6 index5 alt1"><code class="java spaces"> </code><code class="java preprocessor">* @return void</code></div> <div class="line number7 index6 alt2"><code class="java spaces"> </code><code class="java preprocessor">*/</code></div> <div class="line number8 index7 alt1"><code class="java spaces"> </code><code class="java plain">function showVersion()</code></div> <div class="line number9 index8 alt2"><code class="java spaces"> </code><code class="java plain">{</code></div> <div class="line number10 index9 alt1"><code class="java spaces"> </code><code class="java plain"><...></code></div> <div class="line number11 index10 alt2"><code class="java spaces"> </code><code class="java plain">}</code></div> </div> </td> </tr> </tbody> </table> </div> </div> <p> </p> <p lang="en-US">// =============================</p> <p lang="en-US"> </p> <p lang="en-US">@author</p> <p lang="en-US"> </p> <p> </p> <div> <div class="syntaxhighlighter java" id="highlighter_834932"> <div class="toolbar"><span><a class="toolbar_item command_help help" href="http://www.2cto.com/kf/201408/322110.html#">?</a></span></div> <table border="0" cellpadding="0" cellspacing="0"> <tbody> <tr> <td class="gutter"> <div class="line number1 index0 alt2">1</div> <div class="line number2 index1 alt1">2</div> <div class="line number3 index2 alt2">3</div> <div class="line number4 index3 alt1">4</div> </td> <td class="code"> <div class="container"> <div class="line number1 index0 alt2"><code class="java preprocessor">/**</code></div> <div class="line number2 index1 alt1"><code class="java spaces"> </code><code class="java preprocessor">* @author My Name</code></div> <div class="line number3 index2 alt2"><code class="java spaces"> </code><code class="java preprocessor">* @author My Name <my.name@example.com></code></div> <div class="line number4 index3 alt1"><code class="java spaces"> </code><code class="java preprocessor">*/</code><code class="java plain"></my.name</code><code class="java color1">@example</code><code class="java plain">.com></code></div> </div> </td> </tr> </tbody> </table> </div> </div> <p> </p> <p lang="en-US"> </p> <p lang="en-US">// =============================</p> <p lang="en-US"> </p> <p lang="en-US">@category</p> <p lang="en-US"> </p> <p> </p> <div> <div class="syntaxhighlighter java" id="highlighter_567800"> <div class="toolbar"><span><a class="toolbar_item command_help help" href="http://www.2cto.com/kf/201408/322110.html#">?</a></span></div> <table border="0" cellpadding="0" cellspacing="0"> <tbody> <tr> <td class="gutter"> <div class="line number1 index0 alt2">1</div> <div class="line number2 index1 alt1">2</div> <div class="line number3 index2 alt2">3</div> <div class="line number4 index3 alt1">4</div> <div class="line number5 index4 alt2">5</div> <div class="line number6 index5 alt1">6</div> </td> <td class="code"> <div class="container"> <div class="line number1 index0 alt2"><code class="java preprocessor">/**</code></div> <div class="line number2 index1 alt1"><code class="java spaces"> </code><code class="java preprocessor">* Page-Level DocBlock</code></div> <div class="line number3 index2 alt2"><code class="java spaces"> </code><code class="java preprocessor">*</code></div> <div class="line number4 index3 alt1"><code class="java spaces"> </code><code class="java preprocessor">* @category MyCategory</code></div> <div class="line number5 index4 alt2"><code class="java spaces"> </code><code class="java preprocessor">* @package MyPackage</code></div> <div class="line number6 index5 alt1"><code class="java spaces"> </code><code class="java preprocessor">*/</code></div> </div> </td> </tr> </tbody> </table> </div> </div> <p> </p> <p lang="en-US"> </p> <p lang="en-US">// =============================</p> <p lang="en-US"> </p> <p lang="en-US">@copyright</p> <p lang="en-US"> </p> <p> </p> <div> <div class="syntaxhighlighter java" id="highlighter_503124"> <div class="toolbar"><span><a class="toolbar_item command_help help" href="http://www.2cto.com/kf/201408/322110.html#">?</a></span></div> <table border="0" cellpadding="0" cellspacing="0"> <tbody> <tr> <td class="gutter"> <div class="line number1 index0 alt2">1</div> <div class="line number2 index1 alt1">2</div> <div class="line number3 index2 alt2">3</div> </td> <td class="code"> <div class="container"> <div class="line number1 index0 alt2"><code class="java preprocessor">/**</code></div> <div class="line number2 index1 alt1"><code class="java spaces"> </code><code class="java preprocessor">* @copyright 1997-2005 The PHP Group</code></div> <div class="line number3 index2 alt2"><code class="java spaces"> </code><code class="java preprocessor">*/</code></div> </div> </td> </tr> </tbody> </table> </div> </div> <p> </p> <p lang="en-US"> </p> <p lang="en-US">// =============================</p> <p lang="en-US"> </p> <p lang="en-US">@deprecated</p> <p lang="en-US"> </p> <p> </p> <div> <div class="syntaxhighlighter java" id="highlighter_936169"> <div class="toolbar"><span><a class="toolbar_item command_help help" href="http://www.2cto.com/kf/201408/322110.html#">?</a></span></div> <table border="0" cellpadding="0" cellspacing="0"> <tbody> <tr> <td class="gutter"> <div class="line number1 index0 alt2">1</div> <div class="line number2 index1 alt1">2</div> <div class="line number3 index2 alt2">3</div> <div class="line number4 index3 alt1">4</div> <div class="line number5 index4 alt2">5</div> <div class="line number6 index5 alt1">6</div> <div class="line number7 index6 alt2">7</div> <div class="line number8 index7 alt1">8</div> <div class="line number9 index8 alt2">9</div> <div class="line number10 index9 alt1">10</div> </td> <td class="code"> <div class="container"> <div class="line number1 index0 alt2"><code class="java preprocessor">/**</code></div> <div class="line number2 index1 alt1"><code class="java spaces"> </code><code class="java preprocessor">* @deprecated</code></div> <div class="line number3 index2 alt2"><code class="java spaces"> </code><code class="java preprocessor">* @deprecated 1.0.0</code></div> <div class="line number4 index3 alt1"><code class="java spaces"> </code><code class="java preprocessor">* @deprecated No longer used by internal code and not recommended.</code></div> <div class="line number5 index4 alt2"><code class="java spaces"> </code><code class="java preprocessor">* @deprecated 1.0.0 No longer used by internal code and not recommended.</code></div> <div class="line number6 index5 alt1"><code class="java spaces"> </code><code class="java preprocessor">*/</code></div> <div class="line number7 index6 alt2"><code class="java spaces"> </code><code class="java plain">function count()</code></div> <div class="line number8 index7 alt1"><code class="java spaces"> </code><code class="java plain">{</code></div> <div class="line number9 index8 alt2"><code class="java spaces"> </code><code class="java plain"><...></code></div> <div class="line number10 index9 alt1"><code class="java spaces"> </code><code class="java plain">}</code></div> </div> </td> </tr> </tbody> </table> </div> </div> <p> </p> <p lang="en-US"> </p> <p lang="en-US">// =============================</p> <p lang="en-US"> </p> <p lang="en-US">@example</p> <p lang="en-US"> </p> <p> </p> <div> <div class="syntaxhighlighter java" id="highlighter_338185"> <div class="toolbar"><span><a class="toolbar_item command_help help" href="http://www.2cto.com/kf/201408/322110.html#">?</a></span></div> <table border="0" cellpadding="0" cellspacing="0"> <tbody> <tr> <td class="gutter"> <div class="line number1 index0 alt2">1</div> <div class="line number2 index1 alt1">2</div> <div class="line number3 index2 alt2">3</div> <div class="line number4 index3 alt1">4</div> <div class="line number5 index4 alt2">5</div> <div class="line number6 index5 alt1">6</div> <div class="line number7 index6 alt2">7</div> <div class="line number8 index7 alt1">8</div> <div class="line number9 index8 alt2">9</div> </td> <td class="code"> <div class="container"> <div class="line number1 index0 alt2"><code class="java preprocessor">/**</code></div> <div class="line number2 index1 alt1"><code class="java spaces"> </code><code class="java preprocessor">* @example example1.php Counting in action.</code></div> <div class="line number3 index2 alt2"><code class="java spaces"> </code><code class="java preprocessor">* @example <a href="http://example.com/example2.phps">http://example.com/example2.phps</a> Counting in action by a 3rd party.</code></div> <div class="line number4 index3 alt1"><code class="java spaces"> </code><code class="java preprocessor">* @example My Own Example.php My counting.</code></div> <div class="line number5 index4 alt2"><code class="java spaces"> </code><code class="java preprocessor">*/</code></div> <div class="line number6 index5 alt1"><code class="java spaces"> </code><code class="java plain">function count()</code></div> <div class="line number7 index6 alt2"><code class="java spaces"> </code><code class="java plain">{</code></div> <div class="line number8 index7 alt1"><code class="java spaces"> </code><code class="java plain"><...></code></div> <div class="line number9 index8 alt2"><code class="java spaces"> </code><code class="java plain">}</code></div> </div> </td> </tr> </tbody> </table> </div> </div> <p> </p> <p lang="en-US"> </p> <p lang="en-US">// =============================</p> <p> </p> <p lang="en-US">@filesource</p> <p lang="en-US"> </p> <p> </p> <div> <div class="syntaxhighlighter java" id="highlighter_335342"> <div class="toolbar"><span><a class="toolbar_item command_help help" href="http://www.2cto.com/kf/201408/322110.html#">?</a></span></div> <table border="0" cellpadding="0" cellspacing="0"> <tbody> <tr> <td class="gutter"> <div class="line number1 index0 alt2">1</div> <div class="line number2 index1 alt1">2</div> <div class="line number3 index2 alt2">3</div> </td> <td class="code"> <div class="container"> <div class="line number1 index0 alt2"><code class="java preprocessor">/**</code></div> <div class="line number2 index1 alt1"><code class="java spaces"> </code><code class="java preprocessor">* @filesource</code></div> <div class="line number3 index2 alt2"><code class="java spaces"> </code><code class="java preprocessor">*/</code></div> </div> </td> </tr> </tbody> </table> </div> </div> <p> </p> <p lang="en-US"> </p> <p lang="en-US">// =============================</p> <p> </p> <p>@global phpdocumentor2.0不支持</p> <p lang="en-US"> </p> <p lang="en-US">// =============================</p> <p> </p> <p lang="en-US">@ignore</p> <p lang="en-US"> </p> <p> </p> <div> <div class="syntaxhighlighter java" id="highlighter_872317"> <div class="toolbar"><span><a class="toolbar_item command_help help" href="http://www.2cto.com/kf/201408/322110.html#">?</a></span></div> <table border="0" cellpadding="0" cellspacing="0"> <tbody> <tr> <td class="gutter"> <div class="line number1 index0 alt2">1</div> <div class="line number2 index1 alt1">2</div> <div class="line number3 index2 alt2">3</div> <div class="line number4 index3 alt1">4</div> <div class="line number5 index4 alt2">5</div> <div class="line number6 index5 alt1">6</div> <div class="line number7 index6 alt2">7</div> <div class="line number8 index7 alt1">8</div> <div class="line number9 index8 alt2">9</div> <div class="line number10 index9 alt1">10</div> <div class="line number11 index10 alt2">11</div> </td> <td class="code"> <div class="container"> <div class="line number1 index0 alt2"><code class="java keyword">if</code> <code class="java plain">($ostest) {</code></div> <div class="line number2 index1 alt1"><code class="java spaces"> </code><code class="java preprocessor">/**</code></div> <div class="line number3 index2 alt2"><code class="java spaces"> </code><code class="java preprocessor">* This define will either be 'Unix' or 'Windows'</code></div> <div class="line number4 index3 alt1"><code class="java spaces"> </code><code class="java preprocessor">*/</code></div> <div class="line number5 index4 alt2"><code class="java spaces"> </code><code class="java plain">define(OS,Unix);</code></div> <div class="line number6 index5 alt1"><code class="java spaces"> </code><code class="java plain">} </code><code class="java keyword">else</code> <code class="java plain">{</code></div> <div class="line number7 index6 alt2"><code class="java spaces"> </code><code class="java preprocessor">/**</code></div> <div class="line number8 index7 alt1"><code class="java spaces"> </code><code class="java preprocessor">* @ignore</code></div> <div class="line number9 index8 alt2"><code class="java spaces"> </code><code class="java preprocessor">*/</code></div> <div class="line number10 index9 alt1"><code class="java spaces"> </code><code class="java plain">define(OS,Windows);</code></div> <div class="line number11 index10 alt2"><code class="java spaces"> </code><code class="java plain">}</code></div> </div> </td> </tr> </tbody> </table> </div> </div> <p> </p> <p lang="en-US"> </p> <p lang="en-US">// =============================</p> <p> </p> <p lang="en-US">@internal</p> <p lang="en-US"> </p> <p> </p> <div> <div class="syntaxhighlighter java" id="highlighter_181104"> <div class="toolbar"><span><a class="toolbar_item command_help help" href="http://www.2cto.com/kf/201408/322110.html#">?</a></span></div> <table border="0" cellpadding="0" cellspacing="0"> <tbody> <tr> <td class="gutter"> <div class="line number1 index0 alt2">1</div> <div class="line number2 index1 alt1">2</div> <div class="line number3 index2 alt2">3</div> <div class="line number4 index3 alt1">4</div> <div class="line number5 index4 alt2">5</div> <div class="line number6 index5 alt1">6</div> <div class="line number7 index6 alt2">7</div> <div class="line number8 index7 alt1">8</div> <div class="line number9 index8 alt2">9</div> </td> <td class="code"> <div class="container"> <div class="line number1 index0 alt2"><code class="java preprocessor">/**</code></div> <div class="line number2 index1 alt1"><code class="java spaces"> </code><code class="java preprocessor">* @internal</code></div> <div class="line number3 index2 alt2"><code class="java spaces"> </code><code class="java preprocessor">*</code></div> <div class="line number4 index3 alt1"><code class="java spaces"> </code><code class="java preprocessor">* @return integer Indicates the number of items.</code></div> <div class="line number5 index4 alt2"><code class="java spaces"> </code><code class="java preprocessor">*/</code></div> <div class="line number6 index5 alt1"><code class="java plain">function count()</code></div> <div class="line number7 index6 alt2"><code class="java plain">{</code></div> <div class="line number8 index7 alt1"><code class="java spaces"> </code><code class="java plain"><...></code></div> <div class="line number9 index8 alt2"><code class="java plain">}</code></div> </div> </td> </tr> </tbody> </table> </div> </div> <p> </p> <p lang="en-US"> </p> <p> </p> <div> <div class="syntaxhighlighter java" id="highlighter_755556"> <div class="toolbar"><span><a class="toolbar_item command_help help" href="http://www.2cto.com/kf/201408/322110.html#">?</a></span></div> <table border="0" cellpadding="0" cellspacing="0"> <tbody> <tr> <td class="gutter"> <div class="line number1 index0 alt2">1</div> <div class="line number2 index1 alt1">2</div> <div class="line number3 index2 alt2">3</div> <div class="line number4 index3 alt1">4</div> <div class="line number5 index4 alt2">5</div> <div class="line number6 index5 alt1">6</div> <div class="line number7 index6 alt2">7</div> <div class="line number8 index7 alt1">8</div> <div class="line number9 index8 alt2">9</div> <div class="line number10 index9 alt1">10</div> <div class="line number11 index10 alt2">11</div> </td> <td class="code"> <div class="container"> <div class="line number1 index0 alt2"><code class="java preprocessor">/**</code></div> <div class="line number2 index1 alt1"><code class="java spaces"> </code><code class="java preprocessor">* Counts the number of Foo.</code></div> <div class="line number3 index2 alt2"><code class="java spaces"> </code><code class="java preprocessor">*</code></div> <div class="line number4 index3 alt1"><code class="java spaces"> </code><code class="java preprocessor">* {@internal Silently adds one extra Foo to compensate for lack of Foo }}</code></div> <div class="line number5 index4 alt2"><code class="java spaces"> </code><code class="java preprocessor">*</code></div> <div class="line number6 index5 alt1"><code class="java spaces"> </code><code class="java preprocessor">* @return integer Indicates the number of items.</code></div> <div class="line number7 index6 alt2"><code class="java spaces"> </code><code class="java preprocessor">*/</code></div> <div class="line number8 index7 alt1"><code class="java plain">function count()</code></div> <div class="line number9 index8 alt2"><code class="java plain">{</code></div> <div class="line number10 index9 alt1"><code class="java spaces"> </code><code class="java plain"><...></code></div> <div class="line number11 index10 alt2"><code class="java plain">}</code></div> </div> </td> </tr> </tbody> </table> </div> </div> <p> </p> <p lang="en-US"> </p> <p lang="en-US">// =============================</p> <p> </p> <p lang="en-US">@license</p> <p lang="en-US"> </p> <p> </p> <div> <div class="syntaxhighlighter java" id="highlighter_351377"> <div class="toolbar"><span><a class="toolbar_item command_help help" href="http://www.2cto.com/kf/201408/322110.html#">?</a></span></div> <table border="0" cellpadding="0" cellspacing="0"> <tbody> <tr> <td class="gutter"> <div class="line number1 index0 alt2">1</div> <div class="line number2 index1 alt1">2</div> <div class="line number3 index2 alt2">3</div> <div class="line number4 index3 alt1">4</div> </td> <td class="code"> <div class="container"> <div class="line number1 index0 alt2"><code class="java preprocessor">/**</code></div> <div class="line number2 index1 alt1"><code class="java spaces"> </code><code class="java preprocessor">* @license GPL</code></div> <div class="line number3 index2 alt2"><code class="java spaces"> </code><code class="java preprocessor">* @license <a href="http://opensource.org/licenses/gpl-license.php">http://opensource.org/licenses/gpl-license.php</a> GNU Public License</code></div> <div class="line number4 index3 alt1"><code class="java spaces"> </code><code class="java preprocessor">*/</code></div> </div> </td> </tr> </tbody> </table> </div> </div> <p> </p> <p lang="en-US"> </p> <p lang="en-US">// =============================</p> <p> </p> <p lang="en-US">@link</p> <p lang="en-US"> </p> <p> </p> <div> <div class="syntaxhighlighter java" id="highlighter_639837"> <div class="toolbar"><span><a class="toolbar_item command_help help" href="http://www.2cto.com/kf/201408/322110.html#">?</a></span></div> <table border="0" cellpadding="0" cellspacing="0"> <tbody> <tr> <td class="gutter"> <div class="line number1 index0 alt2">1</div> <div class="line number2 index1 alt1">2</div> <div class="line number3 index2 alt2">3</div> <div class="line number4 index3 alt1">4</div> <div class="line number5 index4 alt2">5</div> <div class="line number6 index5 alt1">6</div> <div class="line number7 index6 alt2">7</div> <div class="line number8 index7 alt1">8</div> <div class="line number9 index8 alt2">9</div> </td> <td class="code"> <div class="container"> <div class="line number1 index0 alt2"><code class="java preprocessor">/**</code></div> <div class="line number2 index1 alt1"><code class="java spaces"> </code><code class="java preprocessor">* @link <a href="http://example.com/my/bar">http://example.com/my/bar</a> Documentation of Foo.</code></div> <div class="line number3 index2 alt2"><code class="java spaces"> </code><code class="java preprocessor">*</code></div> <div class="line number4 index3 alt1"><code class="java spaces"> </code><code class="java preprocessor">* @return integer Indicates the number of items.</code></div> <div class="line number5 index4 alt2"><code class="java spaces"> </code><code class="java preprocessor">*/</code></div> <div class="line number6 index5 alt1"><code class="java spaces"> </code><code class="java plain">function count()</code></div> <div class="line number7 index6 alt2"><code class="java spaces"> </code><code class="java plain">{</code></div> <div class="line number8 index7 alt1"><code class="java spaces"> </code><code class="java plain"><...></code></div> <div class="line number9 index8 alt2"><code class="java spaces"> </code><code class="java plain">}</code></div> </div> </td> </tr> </tbody> </table> </div> </div> <p> </p> <p lang="en-US"> </p> <p> </p> <div> <div class="syntaxhighlighter java" id="highlighter_722314"> <div class="toolbar"><span><a class="toolbar_item command_help help" href="http://www.2cto.com/kf/201408/322110.html#">?</a></span></div> <table border="0" cellpadding="0" cellspacing="0"> <tbody> <tr> <td class="gutter"> <div class="line number1 index0 alt2">1</div> <div class="line number2 index1 alt1">2</div> <div class="line number3 index2 alt2">3</div> <div class="line number4 index3 alt1">4</div> <div class="line number5 index4 alt2">5</div> <div class="line number6 index5 alt1">6</div> <div class="line number7 index6 alt2">7</div> <div class="line number8 index7 alt1">8</div> <div class="line number9 index8 alt2">9</div> <div class="line number10 index9 alt1">10</div> <div class="line number11 index10 alt2">11</div> <div class="line number12 index11 alt1">12</div> </td> <td class="code"> <div class="container"> <div class="line number1 index0 alt2"><code class="java preprocessor">/**</code></div> <div class="line number2 index1 alt1"><code class="java spaces"> </code><code class="java preprocessor">* This method counts the occurrences of Foo.</code></div> <div class="line number3 index2 alt2"><code class="java spaces"> </code><code class="java preprocessor">*</code></div> <div class="line number4 index3 alt1"><code class="java spaces"> </code><code class="java preprocessor">* When no more Foo ({@link <a href="http://example.com/my/bar">http://example.com/my/bar</a>}) are given this</code></div> <div class="line number5 index4 alt2"><code class="java spaces"> </code><code class="java preprocessor">* function will add one as there must always be one Foo.</code></div> <div class="line number6 index5 alt1"><code class="java spaces"> </code><code class="java preprocessor">*</code></div> <div class="line number7 index6 alt2"><code class="java spaces"> </code><code class="java preprocessor">* @return integer Indicates the number of items.</code></div> <div class="line number8 index7 alt1"><code class="java spaces"> </code><code class="java preprocessor">*/</code></div> <div class="line number9 index8 alt2"><code class="java spaces"> </code><code class="java plain">function count()</code></div> <div class="line number10 index9 alt1"><code class="java spaces"> </code><code class="java plain">{</code></div> <div class="line number11 index10 alt2"><code class="java spaces"> </code><code class="java plain"><...></code></div> <div class="line number12 index11 alt1"><code class="java spaces"> </code><code class="java plain">}</code></div> </div> </td> </tr> </tbody> </table> </div> </div> <p> </p> <p lang="en-US"> </p> <p lang="en-US">// =============================</p> <p> </p> <p lang="en-US">@method</p> <p lang="en-US"> </p> <p> </p> <div> <div class="syntaxhighlighter java" id="highlighter_167785"> <div class="toolbar"><span><a class="toolbar_item command_help help" href="http://www.2cto.com/kf/201408/322110.html#">?</a></span></div> <table border="0" cellpadding="0" cellspacing="0"> <tbody> <tr> <td class="gutter"> <div class="line number1 index0 alt2">1</div> <div class="line number2 index1 alt1">2</div> <div class="line number3 index2 alt2">3</div> <div class="line number4 index3 alt1">4</div> <div class="line number5 index4 alt2">5</div> <div class="line number6 index5 alt1">6</div> <div class="line number7 index6 alt2">7</div> <div class="line number8 index7 alt1">8</div> <div class="line number9 index8 alt2">9</div> <div class="line number10 index9 alt1">10</div> <div class="line number11 index10 alt2">11</div> <div class="line number12 index11 alt1">12</div> <div class="line number13 index12 alt2">13</div> <div class="line number14 index13 alt1">14</div> <div class="line number15 index14 alt2">15</div> <div class="line number16 index15 alt1">16</div> <div class="line number17 index16 alt2">17</div> </td> <td class="code"> <div class="container"> <div class="line number1 index0 alt2"><code class="java keyword">class</code> <code class="java plain">Parent</code></div> <div class="line number2 index1 alt1"><code class="java spaces"> </code><code class="java plain">{</code></div> <div class="line number3 index2 alt2"><code class="java spaces"> </code><code class="java keyword">public</code> <code class="java plain">function __call()</code></div> <div class="line number4 index3 alt1"><code class="java spaces"> </code><code class="java plain">{</code></div> <div class="line number5 index4 alt2"><code class="java spaces"> </code><code class="java plain"><...></code></div> <div class="line number6 index5 alt1"><code class="java spaces"> </code><code class="java plain">}</code></div> <div class="line number7 index6 alt2"><code class="java spaces"> </code><code class="java plain">}</code></div> <div class="line number8 index7 alt1"><code class="java spaces"> </code> </div> <div class="line number9 index8 alt2"><code class="java spaces"> </code><code class="java preprocessor">/**</code></div> <div class="line number10 index9 alt1"><code class="java spaces"> </code><code class="java preprocessor">* @method string getString()</code></div> <div class="line number11 index10 alt2"><code class="java spaces"> </code><code class="java preprocessor">* @method void setInteger(integer $integer)</code></div> <div class="line number12 index11 alt1"><code class="java spaces"> </code><code class="java preprocessor">* @method setString(integer $integer)</code></div> <div class="line number13 index12 alt2"><code class="java spaces"> </code><code class="java preprocessor">*/</code></div> <div class="line number14 index13 alt1"><code class="java spaces"> </code><code class="java keyword">class</code> <code class="java plain">Child </code><code class="java keyword">extends</code> <code class="java plain">Parent</code></div> <div class="line number15 index14 alt2"><code class="java spaces"> </code><code class="java plain">{</code></div> <div class="line number16 index15 alt1"><code class="java spaces"> </code><code class="java plain"><...></code></div> <div class="line number17 index16 alt2"><code class="java spaces"> </code><code class="java plain">}</code></div> </div> </td> </tr> </tbody> </table> </div> </div> <p> </p> <p lang="en-US"> </p> <p lang="en-US">// =============================</p> <p> </p> <p lang="en-US">@package</p> <p lang="en-US"> </p> <p> </p> <div> <div class="syntaxhighlighter java" id="highlighter_251183"> <div class="toolbar"><span><a class="toolbar_item command_help help" href="http://www.2cto.com/kf/201408/322110.html#">?</a></span></div> <table border="0" cellpadding="0" cellspacing="0"> <tbody> <tr> <td class="gutter"> <div class="line number1 index0 alt2">1</div> <div class="line number2 index1 alt1">2</div> <div class="line number3 index2 alt2">3</div> </td> <td class="code"> <div class="container"> <div class="line number1 index0 alt2"><code class="java preprocessor">/**</code></div> <div class="line number2 index1 alt1"><code class="java spaces"> </code><code class="java preprocessor">* @package PSRDocumentationAPI</code></div> <div class="line number3 index2 alt2"><code class="java spaces"> </code><code class="java preprocessor">*/</code></div> </div> </td> </tr> </tbody> </table> </div> </div> <p> </p> <p lang="en-US"> </p> <p lang="en-US">// =============================</p> <p> </p> <p lang="en-US">@param</p> <p lang="en-US"> </p> <p> </p> <div> <div class="syntaxhighlighter java" id="highlighter_365002"> <div class="toolbar"><span><a class="toolbar_item command_help help" href="http://www.2cto.com/kf/201408/322110.html#">?</a></span></div> <table border="0" cellpadding="0" cellspacing="0"> <tbody> <tr> <td class="gutter"> <div class="line number1 index0 alt2">1</div> <div class="line number2 index1 alt1">2</div> <div class="line number3 index2 alt2">3</div> <div class="line number4 index3 alt1">4</div> <div class="line number5 index4 alt2">5</div> <div class="line number6 index5 alt1">6</div> <div class="line number7 index6 alt2">7</div> <div class="line number8 index7 alt1">8</div> <div class="line number9 index8 alt2">9</div> <div class="line number10 index9 alt1">10</div> <div class="line number11 index10 alt2">11</div> </td> <td class="code"> <div class="container"> <div class="line number1 index0 alt2"><code class="java preprocessor">/**</code></div> <div class="line number2 index1 alt1"><code class="java spaces"> </code><code class="java preprocessor">* Counts the number of items in the provided array.</code></div> <div class="line number3 index2 alt2"><code class="java spaces"> </code><code class="java preprocessor">*</code></div> <div class="line number4 index3 alt1"><code class="java spaces"> </code><code class="java preprocessor">* @param mixed[] $items Array structure to count the elements of.</code></div> <div class="line number5 index4 alt2"><code class="java spaces"> </code><code class="java preprocessor">*</code></div> <div class="line number6 index5 alt1"><code class="java spaces"> </code><code class="java preprocessor">* @return int Returns the number of elements.</code></div> <div class="line number7 index6 alt2"><code class="java spaces"> </code><code class="java preprocessor">*/</code></div> <div class="line number8 index7 alt1"><code class="java spaces"> </code><code class="java plain">function count(array $items)</code></div> <div class="line number9 index8 alt2"><code class="java spaces"> </code><code class="java plain">{</code></div> <div class="line number10 index9 alt1"><code class="java spaces"> </code><code class="java plain"><...></code></div> <div class="line number11 index10 alt2"><code class="java spaces"> </code><code class="java plain">}</code></div> </div> </td> </tr> </tbody> </table> </div> </div> <p> </p> <p lang="en-US"> </p> <p lang="en-US">// =============================</p> <p> </p> <p lang="en-US">@property</p> <p lang="en-US"> </p> <p> </p> <div> <div class="syntaxhighlighter java" id="highlighter_374335"> <div class="toolbar"><span><a class="toolbar_item command_help help" href="http://www.2cto.com/kf/201408/322110.html#">?</a></span></div> <table border="0" cellpadding="0" cellspacing="0"> <tbody> <tr> <td class="gutter"> <div class="line number1 index0 alt2">1</div> <div class="line number2 index1 alt1">2</div> <div class="line number3 index2 alt2">3</div> <div class="line number4 index3 alt1">4</div> <div class="line number5 index4 alt2">5</div> <div class="line number6 index5 alt1">6</div> <div class="line number7 index6 alt2">7</div> <div class="line number8 index7 alt1">8</div> <div class="line number9 index8 alt2">9</div> <div class="line number10 index9 alt1">10</div> <div class="line number11 index10 alt2">11</div> <div class="line number12 index11 alt1">12</div> <div class="line number13 index12 alt2">13</div> <div class="line number14 index13 alt1">14</div> <div class="line number15 index14 alt2">15</div> </td> <td class="code"> <div class="container"> <div class="line number1 index0 alt2"><code class="java keyword">class</code> <code class="java plain">Parent</code></div> <div class="line number2 index1 alt1"><code class="java spaces"> </code><code class="java plain">{</code></div> <div class="line number3 index2 alt2"><code class="java spaces"> </code><code class="java keyword">public</code> <code class="java plain">function __get()</code></div> <div class="line number4 index3 alt1"><code class="java spaces"> </code><code class="java plain">{</code></div> <div class="line number5 index4 alt2"><code class="java spaces"> </code><code class="java plain"><...></code></div> <div class="line number6 index5 alt1"><code class="java spaces"> </code><code class="java plain">}</code></div> <div class="line number7 index6 alt2"><code class="java spaces"> </code><code class="java plain">}</code></div> <div class="line number8 index7 alt1"><code class="java spaces"> </code> </div> <div class="line number9 index8 alt2"><code class="java spaces"> </code><code class="java preprocessor">/**</code></div> <div class="line number10 index9 alt1"><code class="java spaces"> </code><code class="java preprocessor">* @property string $myProperty</code></div> <div class="line number11 index10 alt2"><code class="java spaces"> </code><code class="java preprocessor">*/</code></div> <div class="line number12 index11 alt1"><code class="java spaces"> </code><code class="java keyword">class</code> <code class="java plain">Child </code><code class="java keyword">extends</code> <code class="java plain">Parent</code></div> <div class="line number13 index12 alt2"><code class="java spaces"> </code><code class="java plain">{</code></div> <div class="line number14 index13 alt1"><code class="java spaces"> </code><code class="java plain"><...></code></div> <div class="line number15 index14 alt2"><code class="java spaces"> </code><code class="java plain">}</code></div> </div> </td> </tr> </tbody> </table> </div> </div> <p> </p> <p lang="en-US"> </p> <p lang="en-US">// =============================</p> <p> </p> <p lang="en-US">@property-read</p> <p lang="en-US"> </p> <p> </p> <div> <div class="syntaxhighlighter java" id="highlighter_461244"> <div class="toolbar"><span><a class="toolbar_item command_help help" href="http://www.2cto.com/kf/201408/322110.html#">?</a></span></div> <table border="0" cellpadding="0" cellspacing="0"> <tbody> <tr> <td class="gutter"> <div class="line number1 index0 alt2">1</div> <div class="line number2 index1 alt1">2</div> <div class="line number3 index2 alt2">3</div> <div class="line number4 index3 alt1">4</div> <div class="line number5 index4 alt2">5</div> <div class="line number6 index5 alt1">6</div> <div class="line number7 index6 alt2">7</div> <div class="line number8 index7 alt1">8</div> <div class="line number9 index8 alt2">9</div> <div class="line number10 index9 alt1">10</div> <div class="line number11 index10 alt2">11</div> <div class="line number12 index11 alt1">12</div> <div class="line number13 index12 alt2">13</div> <div class="line number14 index13 alt1">14</div> <div class="line number15 index14 alt2">15</div> </td> <td class="code"> <div class="container"> <div class="line number1 index0 alt2"><code class="java keyword">class</code> <code class="java plain">Parent</code></div> <div class="line number2 index1 alt1"><code class="java spaces"> </code><code class="java plain">{</code></div> <div class="line number3 index2 alt2"><code class="java spaces"> </code><code class="java keyword">public</code> <code class="java plain">function __get()</code></div> <div class="line number4 index3 alt1"><code class="java spaces"> </code><code class="java plain">{</code></div> <div class="line number5 index4 alt2"><code class="java spaces"> </code><code class="java plain"><...></code></div> <div class="line number6 index5 alt1"><code class="java spaces"> </code><code class="java plain">}</code></div> <div class="line number7 index6 alt2"><code class="java spaces"> </code><code class="java plain">}</code></div> <div class="line number8 index7 alt1"><code class="java spaces"> </code> </div> <div class="line number9 index8 alt2"><code class="java spaces"> </code><code class="java preprocessor">/**</code></div> <div class="line number10 index9 alt1"><code class="java spaces"> </code><code class="java preprocessor">* @property-read string $myProperty</code></div> <div class="line number11 index10 alt2"><code class="java spaces"> </code><code class="java preprocessor">*/</code></div> <div class="line number12 index11 alt1"><code class="java spaces"> </code><code class="java keyword">class</code> <code class="java plain">Child </code><code class="java keyword">extends</code> <code class="java plain">Parent</code></div> <div class="line number13 index12 alt2"><code class="java spaces"> </code><code class="java plain">{</code></div> <div class="line number14 index13 alt1"><code class="java spaces"> </code><code class="java plain"><...></code></div> <div class="line number15 index14 alt2"><code class="java spaces"> </code><code class="java plain">}</code></div> </div> </td> </tr> </tbody> </table> </div> </div> <p> </p> <p lang="en-US"> </p> <p lang="en-US">// =============================</p> <p> </p> <p lang="en-US">@property-write</p> <p lang="en-US"> </p> <p> </p> <div> <div class="syntaxhighlighter java" id="highlighter_828456"> <div class="toolbar"><span><a class="toolbar_item command_help help" href="http://www.2cto.com/kf/201408/322110.html#">?</a></span></div> <table border="0" cellpadding="0" cellspacing="0"> <tbody> <tr> <td class="gutter"> <div class="line number1 index0 alt2">1</div> <div class="line number2 index1 alt1">2</div> <div class="line number3 index2 alt2">3</div> <div class="line number4 index3 alt1">4</div> <div class="line number5 index4 alt2">5</div> <div class="line number6 index5 alt1">6</div> <div class="line number7 index6 alt2">7</div> <div class="line number8 index7 alt1">8</div> <div class="line number9 index8 alt2">9</div> <div class="line number10 index9 alt1">10</div> <div class="line number11 index10 alt2">11</div> <div class="line number12 index11 alt1">12</div> <div class="line number13 index12 alt2">13</div> <div class="line number14 index13 alt1">14</div> <div class="line number15 index14 alt2">15</div> </td> <td class="code"> <div class="container"> <div class="line number1 index0 alt2"><code class="java keyword">class</code> <code class="java plain">Parent</code></div> <div class="line number2 index1 alt1"><code class="java plain">{</code></div> <div class="line number3 index2 alt2"><code class="java spaces"> </code><code class="java keyword">public</code> <code class="java plain">function __set()</code></div> <div class="line number4 index3 alt1"><code class="java spaces"> </code><code class="java plain">{</code></div> <div class="line number5 index4 alt2"><code class="java spaces"> </code><code class="java plain"><...></code></div> <div class="line number6 index5 alt1"><code class="java spaces"> </code><code class="java plain">}</code></div> <div class="line number7 index6 alt2"><code class="java plain">}</code></div> <div class="line number8 index7 alt1"> </div> <div class="line number9 index8 alt2"><code class="java preprocessor">/**</code></div> <div class="line number10 index9 alt1"><code class="java spaces"> </code><code class="java preprocessor">* @property-write string $myProperty</code></div> <div class="line number11 index10 alt2"><code class="java spaces"> </code><code class="java preprocessor">*/</code></div> <div class="line number12 index11 alt1"><code class="java keyword">class</code> <code class="java plain">Child </code><code class="java keyword">extends</code> <code class="java plain">Parent</code></div> <div class="line number13 index12 alt2"><code class="java plain">{</code></div> <div class="line number14 index13 alt1"><code class="java spaces"> </code><code class="java plain"><...></code></div> <div class="line number15 index14 alt2"><code class="java plain">}</code></div> </div> </td> </tr> </tbody> </table> </div> </div> <p> </p> <p lang="en-US"> </p> <p lang="en-US">// =============================</p> <p> </p> <p lang="en-US">@return</p> <p lang="en-US"> </p> <p> </p> <div> <div class="syntaxhighlighter java" id="highlighter_981581"> <div class="toolbar"><span><a class="toolbar_item command_help help" href="http://www.2cto.com/kf/201408/322110.html#">?</a></span></div> <table border="0" cellpadding="0" cellspacing="0"> <tbody> <tr> <td class="gutter"> <div class="line number1 index0 alt2">1</div> <div class="line number2 index1 alt1">2</div> <div class="line number3 index2 alt2">3</div> <div class="line number4 index3 alt1">4</div> <div class="line number5 index4 alt2">5</div> <div class="line number6 index5 alt1">6</div> <div class="line number7 index6 alt2">7</div> </td> <td class="code"> <div class="container"> <div class="line number1 index0 alt2"><code class="java preprocessor">/**</code></div> <div class="line number2 index1 alt1"><code class="java spaces"> </code><code class="java preprocessor">* @return integer Indicates the number of items.</code></div> <div class="line number3 index2 alt2"><code class="java spaces"> </code><code class="java preprocessor">*/</code></div> <div class="line number4 index3 alt1"><code class="java spaces"> </code><code class="java plain">function count()</code></div> <div class="line number5 index4 alt2"><code class="java spaces"> </code><code class="java plain">{</code></div> <div class="line number6 index5 alt1"><code class="java spaces"> </code><code class="java plain"><...></code></div> <div class="line number7 index6 alt2"><code class="java spaces"> </code><code class="java plain">}</code></div> </div> </td> </tr> </tbody> </table> </div> </div> <p> </p> <p> </p> <div> <div class="syntaxhighlighter java" id="highlighter_987543"> <div class="toolbar"><span><a class="toolbar_item command_help help" href="http://www.2cto.com/kf/201408/322110.html#">?</a></span></div> <table border="0" cellpadding="0" cellspacing="0"> <tbody> <tr> <td class="gutter"> <div class="line number1 index0 alt2">1</div> <div class="line number2 index1 alt1">2</div> <div class="line number3 index2 alt2">3</div> <div class="line number4 index3 alt1">4</div> <div class="line number5 index4 alt2">5</div> <div class="line number6 index5 alt1">6</div> <div class="line number7 index6 alt2">7</div> </td> <td class="code"> <div class="container"> <div class="line number1 index0 alt2"><code class="java preprocessor">/**</code></div> <div class="line number2 index1 alt1"><code class="java spaces"> </code><code class="java preprocessor">* @return string|null The label's text or null if none provided.</code></div> <div class="line number3 index2 alt2"><code class="java spaces"> </code><code class="java preprocessor">*/</code></div> <div class="line number4 index3 alt1"><code class="java spaces"> </code><code class="java plain">function getLabel()</code></div> <div class="line number5 index4 alt2"><code class="java spaces"> </code><code class="java plain">{</code></div> <div class="line number6 index5 alt1"><code class="java spaces"> </code><code class="java plain"><...></code></div> <div class="line number7 index6 alt2"><code class="java spaces"> </code><code class="java plain">}</code></div> </div> </td> </tr> </tbody> </table> </div> </div> <p> </p> <p lang="en-US"> </p> <p lang="en-US">// =============================</p> <p> </p> <p lang="en-US">@see</p> <p lang="en-US"> </p> <p> </p> <div> <div class="syntaxhighlighter java" id="highlighter_952255"> <div class="toolbar"><span><a class="toolbar_item command_help help" href="http://www.2cto.com/kf/201408/322110.html#">?</a></span></div> <table border="0" cellpadding="0" cellspacing="0"> <tbody> <tr> <td class="gutter"> <div class="line number1 index0 alt2">1</div> <div class="line number2 index1 alt1">2</div> <div class="line number3 index2 alt2">3</div> <div class="line number4 index3 alt1">4</div> <div class="line number5 index4 alt2">5</div> <div class="line number6 index5 alt1">6</div> <div class="line number7 index6 alt2">7</div> <div class="line number8 index7 alt1">8</div> <div class="line number9 index8 alt2">9</div> <div class="line number10 index9 alt1">10</div> <div class="line number11 index10 alt2">11</div> </td> <td class="code"> <div class="container"> <div class="line number1 index0 alt2"><code class="java preprocessor">/**</code></div> <div class="line number2 index1 alt1"><code class="java spaces"> </code><code class="java preprocessor">* @see <a href="http://example.com/my/bar">http://example.com/my/bar</a> Documentation of Foo.</code></div> <div class="line number3 index2 alt2"><code class="java spaces"> </code><code class="java preprocessor">* @see MyClass::$items for the property whose items are counted</code></div> <div class="line number4 index3 alt1"><code class="java spaces"> </code><code class="java preprocessor">* @see MyClass::setItems() to set the items for this collection.</code></div> <div class="line number5 index4 alt2"><code class="java spaces"> </code><code class="java preprocessor">*</code></div> <div class="line number6 index5 alt1"><code class="java spaces"> </code><code class="java preprocessor">* @return integer Indicates the number of items.</code></div> <div class="line number7 index6 alt2"><code class="java spaces"> </code><code class="java preprocessor">*/</code></div> <div class="line number8 index7 alt1"><code class="java plain">function count()</code></div> <div class="line number9 index8 alt2"><code class="java plain">{</code></div> <div class="line number10 index9 alt1"><code class="java spaces"> </code><code class="java plain"><...></code></div> <div class="line number11 index10 alt2"><code class="java plain">}</code></div> </div> </td> </tr> </tbody> </table> </div> </div> <p> </p> <p lang="en-US"> </p> <p lang="en-US">// =============================</p> <p lang="en-US"> </p> <p lang="en-US">@since</p> <p lang="en-US"> </p> <p> </p> <div> <div class="syntaxhighlighter java" id="highlighter_293070"> <div class="toolbar"><span><a class="toolbar_item command_help help" href="http://www.2cto.com/kf/201408/322110.html#">?</a></span></div> <table border="0" cellpadding="0" cellspacing="0"> <tbody> <tr> <td class="gutter"> <div class="line number1 index0 alt2">1</div> <div class="line number2 index1 alt1">2</div> <div class="line number3 index2 alt2">3</div> <div class="line number4 index3 alt1">4</div> <div class="line number5 index4 alt2">5</div> <div class="line number6 index5 alt1">6</div> <div class="line number7 index6 alt2">7</div> <div class="line number8 index7 alt1">8</div> <div class="line number9 index8 alt2">9</div> </td> <td class="code"> <div class="container"> <div class="line number1 index0 alt2"><code class="java preprocessor">/**</code></div> <div class="line number2 index1 alt1"><code class="java spaces"> </code><code class="java preprocessor">* @since 1.0.1 First time this was introduced.</code></div> <div class="line number3 index2 alt2"><code class="java spaces"> </code><code class="java preprocessor">*</code></div> <div class="line number4 index3 alt1"><code class="java spaces"> </code><code class="java preprocessor">* @return integer Indicates the number of items.</code></div> <div class="line number5 index4 alt2"><code class="java spaces"> </code><code class="java preprocessor">*/</code></div> <div class="line number6 index5 alt1"><code class="java spaces"> </code><code class="java plain">function count()</code></div> <div class="line number7 index6 alt2"><code class="java spaces"> </code><code class="java plain">{</code></div> <div class="line number8 index7 alt1"><code class="java spaces"> </code><code class="java plain"><...></code></div> <div class="line number9 index8 alt2"><code class="java spaces"> </code><code class="java plain">}</code></div> </div> </td> </tr> </tbody> </table> </div> </div> <p> </p> <p> </p> <p> </p> <div> <div class="syntaxhighlighter java" id="highlighter_684009"> <div class="toolbar"><span><a class="toolbar_item command_help help" href="http://www.2cto.com/kf/201408/322110.html#">?</a></span></div> <table border="0" cellpadding="0" cellspacing="0"> <tbody> <tr> <td class="gutter"> <div class="line number1 index0 alt2">1</div> <div class="line number2 index1 alt1">2</div> <div class="line number3 index2 alt2">3</div> <div class="line number4 index3 alt1">4</div> <div class="line number5 index4 alt2">5</div> <div class="line number6 index5 alt1">6</div> <div class="line number7 index6 alt2">7</div> <div class="line number8 index7 alt1">8</div> <div class="line number9 index8 alt2">9</div> <div class="line number10 index9 alt1">10</div> <div class="line number11 index10 alt2">11</div> </td> <td class="code"> <div class="container"> <div class="line number1 index0 alt2"><code class="java preprocessor">/**</code></div> <div class="line number2 index1 alt1"><code class="java spaces"> </code><code class="java preprocessor">* @since 1.0.2 Added the $b argument.</code></div> <div class="line number3 index2 alt2"><code class="java spaces"> </code><code class="java preprocessor">* @since 1.0.1 Added the $a argument.</code></div> <div class="line number4 index3 alt1"><code class="java spaces"> </code><code class="java preprocessor">* @since 1.0.0</code></div> <div class="line number5 index4 alt2"><code class="java spaces"> </code><code class="java preprocessor">*</code></div> <div class="line number6 index5 alt1"><code class="java spaces"> </code><code class="java preprocessor">* @return void</code></div> <div class="line number7 index6 alt2"><code class="java spaces"> </code><code class="java preprocessor">*/</code></div> <div class="line number8 index7 alt1"><code class="java plain">function dump($a, $b)</code></div> <div class="line number9 index8 alt2"><code class="java plain">{</code></div> <div class="line number10 index9 alt1"><code class="java spaces"> </code><code class="java plain"><...></code></div> <div class="line number11 index10 alt2"><code class="java plain">}</code></div> </div> </td> </tr> </tbody> </table> </div> </div> <p> </p> <p lang="en-US"> </p> <p lang="en-US">// =============================</p> <p> </p> <p lang="en-US">@source</p> <p lang="en-US"> </p> <div> <div class="syntaxhighlighter java" id="highlighter_650219"> <div class="toolbar"><span><a class="toolbar_item command_help help" href="http://www.2cto.com/kf/201408/322110.html#">?</a></span></div> <table border="0" cellpadding="0" cellspacing="0"> <tbody> <tr> <td class="gutter"> <div class="line number1 index0 alt2">1</div> <div class="line number2 index1 alt1">2</div> <div class="line number3 index2 alt2">3</div> <div class="line number4 index3 alt1">4</div> <div class="line number5 index4 alt2">5</div> <div class="line number6 index5 alt1">6</div> <div class="line number7 index6 alt2">7</div> <div class="line number8 index7 alt1">8</div> <div class="line number9 index8 alt2">9</div> </td> <td class="code"> <div class="container"> <div class="line number1 index0 alt2"><code class="java preprocessor">/**</code></div> <div class="line number2 index1 alt1"><code class="java spaces"> </code><code class="java preprocessor">* @source 2 1 Check that ensures lazy counting.</code></div> <div class="line number3 index2 alt2"><code class="java spaces"> </code><code class="java preprocessor">*/</code></div> <div class="line number4 index3 alt1"><code class="java spaces"> </code><code class="java plain">function count()</code></div> <div class="line number5 index4 alt2"><code class="java spaces"> </code><code class="java plain">{</code></div> <div class="line number6 index5 alt1"><code class="java spaces"> </code><code class="java keyword">if</code> <code class="java plain">(</code><code class="java keyword">null</code> <code class="java plain">=== $</code><code class="java keyword">this</code><code class="java plain">->count) {</code></div> <div class="line number7 index6 alt2"><code class="java spaces"> </code><code class="java plain"><...></code></div> <div class="line number8 index7 alt1"><code class="java spaces"> </code><code class="java plain">}</code></div> <div class="line number9 index8 alt2"><code class="java spaces"> </code><code class="java plain">}</code></div> </div> </td> </tr> </tbody> </table> </div> </div> <p> </p> <p> </p> <p lang="en-US">// =============================</p> <p> </p> <p lang="en-US">@subpackage</p> <p lang="en-US"> </p> <p> </p> <div> <div class="syntaxhighlighter java" id="highlighter_833278"> <div class="toolbar"><span><a class="toolbar_item command_help help" href="http://www.2cto.com/kf/201408/322110.html#">?</a></span></div> <table border="0" cellpadding="0" cellspacing="0"> <tbody> <tr> <td class="gutter"> <div class="line number1 index0 alt2">1</div> <div class="line number2 index1 alt1">2</div> <div class="line number3 index2 alt2">3</div> <div class="line number4 index3 alt1">4</div> </td> <td class="code"> <div class="container"> <div class="line number1 index0 alt2"><code class="java preprocessor">/**</code></div> <div class="line number2 index1 alt1"><code class="java spaces"> </code><code class="java preprocessor">* @package PSR</code></div> <div class="line number3 index2 alt2"><code class="java spaces"> </code><code class="java preprocessor">* @subpackage DocumentationAPI</code></div> <div class="line number4 index3 alt1"><code class="java spaces"> </code><code class="java preprocessor">*/</code></div> </div> </td> </tr> </tbody> </table> </div> </div> <p> </p> <p lang="en-US"> </p> <p lang="en-US">// =============================</p> <p> </p> <p lang="en-US">@throws</p> <p lang="en-US"> </p> <p> </p> <div> <div class="syntaxhighlighter java" id="highlighter_781502"> <div class="toolbar"><span><a class="toolbar_item command_help help" href="http://www.2cto.com/kf/201408/322110.html#">?</a></span></div> <table border="0" cellpadding="0" cellspacing="0"> <tbody> <tr> <td class="gutter"> <div class="line number1 index0 alt2">1</div> <div class="line number2 index1 alt1">2</div> <div class="line number3 index2 alt2">3</div> <div class="line number4 index3 alt1">4</div> <div class="line number5 index4 alt2">5</div> <div class="line number6 index5 alt1">6</div> <div class="line number7 index6 alt2">7</div> <div class="line number8 index7 alt1">8</div> <div class="line number9 index8 alt2">9</div> <div class="line number10 index9 alt1">10</div> <div class="line number11 index10 alt2">11</div> <div class="line number12 index11 alt1">12</div> <div class="line number13 index12 alt2">13</div> <div class="line number14 index13 alt1">14</div> </td> <td class="code"> <div class="container"> <div class="line number1 index0 alt2"><code class="java preprocessor">/**</code></div> <div class="line number2 index1 alt1"><code class="java spaces"> </code><code class="java preprocessor">* Counts the number of items in the provided array.</code></div> <div class="line number3 index2 alt2"><code class="java spaces"> </code><code class="java preprocessor">*</code></div> <div class="line number4 index3 alt1"><code class="java spaces"> </code><code class="java preprocessor">* @param mixed[] $array Array structure to count the elements of.</code></div> <div class="line number5 index4 alt2"><code class="java spaces"> </code><code class="java preprocessor">*</code></div> <div class="line number6 index5 alt1"><code class="java spaces"> </code><code class="java preprocessor">* @throws InvalidArgumentException if the provided argument is not of type</code></div> <div class="line number7 index6 alt2"><code class="java spaces"> </code><code class="java preprocessor">* 'array'.</code></div> <div class="line number8 index7 alt1"><code class="java spaces"> </code><code class="java preprocessor">*</code></div> <div class="line number9 index8 alt2"><code class="java spaces"> </code><code class="java preprocessor">* @return int Returns the number of elements.</code></div> <div class="line number10 index9 alt1"><code class="java spaces"> </code><code class="java preprocessor">*/</code></div> <div class="line number11 index10 alt2"><code class="java spaces"> </code><code class="java plain">function count($items)</code></div> <div class="line number12 index11 alt1"><code class="java spaces"> </code><code class="java plain">{</code></div> <div class="line number13 index12 alt2"><code class="java spaces"> </code><code class="java plain"><...></code></div> <div class="line number14 index13 alt1"><code class="java spaces"> </code><code class="java plain">}</code></div> </div> </td> </tr> </tbody> </table> </div> </div> <p> </p> <p lang="en-US"> </p> <p lang="en-US">// =============================</p> <p> </p> <p lang="en-US">@todo</p> <p lang="en-US"> </p> <p> </p> <div> <div class="syntaxhighlighter java" id="highlighter_131632"> <div class="toolbar"><span><a class="toolbar_item command_help help" href="http://www.2cto.com/kf/201408/322110.html#">?</a></span></div> <table border="0" cellpadding="0" cellspacing="0"> <tbody> <tr> <td class="gutter"> <div class="line number1 index0 alt2">1</div> <div class="line number2 index1 alt1">2</div> <div class="line number3 index2 alt2">3</div> <div class="line number4 index3 alt1">4</div> <div class="line number5 index4 alt2">5</div> <div class="line number6 index5 alt1">6</div> <div class="line number7 index6 alt2">7</div> <div class="line number8 index7 alt1">8</div> <div class="line number9 index8 alt2">9</div> <div class="line number10 index9 alt1">10</div> <div class="line number11 index10 alt2">11</div> </td> <td class="code"> <div class="container"> <div class="line number1 index0 alt2"><code class="java preprocessor">/**</code></div> <div class="line number2 index1 alt1"><code class="java spaces"> </code><code class="java preprocessor">* Counts the number of items in the provided array.</code></div> <div class="line number3 index2 alt2"><code class="java spaces"> </code><code class="java preprocessor">*</code></div> <div class="line number4 index3 alt1"><code class="java spaces"> </code><code class="java preprocessor">* @todo add an array parameter to count</code></div> <div class="line number5 index4 alt2"><code class="java spaces"> </code><code class="java preprocessor">*</code></div> <div class="line number6 index5 alt1"><code class="java spaces"> </code><code class="java preprocessor">* @return int Returns the number of elements.</code></div> <div class="line number7 index6 alt2"><code class="java spaces"> </code><code class="java preprocessor">*/</code></div> <div class="line number8 index7 alt1"><code class="java plain">function count()</code></div> <div class="line number9 index8 alt2"><code class="java plain">{</code></div> <div class="line number10 index9 alt1"><code class="java spaces"> </code><code class="java plain"><...></code></div> <div class="line number11 index10 alt2"><code class="java plain">}</code></div> </div> </td> </tr> </tbody> </table> </div> </div> <p> </p> <p lang="en-US"> </p> <p lang="en-US">// =============================</p> <p> </p> <p lang="en-US">@uses</p> <p lang="en-US"> </p> <p> </p> <div> <div class="syntaxhighlighter java" id="highlighter_436438"> <div class="toolbar"><span><a class="toolbar_item command_help help" href="http://www.2cto.com/kf/201408/322110.html#">?</a></span></div> <table border="0" cellpadding="0" cellspacing="0"> <tbody> <tr> <td class="gutter"> <div class="line number1 index0 alt2">1</div> <div class="line number2 index1 alt1">2</div> <div class="line number3 index2 alt2">3</div> <div class="line number4 index3 alt1">4</div> <div class="line number5 index4 alt2">5</div> <div class="line number6 index5 alt1">6</div> <div class="line number7 index6 alt2">7</div> <div class="line number8 index7 alt1">8</div> <div class="line number9 index8 alt2">9</div> </td> <td class="code"> <div class="container"> <div class="line number1 index0 alt2"><code class="java preprocessor">/**</code></div> <div class="line number2 index1 alt1"><code class="java spaces"> </code><code class="java preprocessor">* @uses MyClass::$items to retrieve the count from.</code></div> <div class="line number3 index2 alt2"><code class="java spaces"> </code><code class="java preprocessor">*</code></div> <div class="line number4 index3 alt1"><code class="java spaces"> </code><code class="java preprocessor">* @return integer Indicates the number of items.</code></div> <div class="line number5 index4 alt2"><code class="java spaces"> </code><code class="java preprocessor">*/</code></div> <div class="line number6 index5 alt1"><code class="java spaces"> </code><code class="java plain">function count()</code></div> <div class="line number7 index6 alt2"><code class="java spaces"> </code><code class="java plain">{</code></div> <div class="line number8 index7 alt1"><code class="java spaces"> </code><code class="java plain"><...></code></div> <div class="line number9 index8 alt2"><code class="java spaces"> </code><code class="java plain">}</code></div> </div> </td> </tr> </tbody> </table> </div> </div> <p> </p> <p lang="en-US"> </p> <p lang="en-US">// =============================</p> <p> </p> <p lang="en-US">@var</p> <p lang="en-US"> </p> <p> </p> <div> <div class="syntaxhighlighter java" id="highlighter_227471"> <div class="toolbar"><span><a class="toolbar_item command_help help" href="http://www.2cto.com/kf/201408/322110.html#">?</a></span></div> <table border="0" cellpadding="0" cellspacing="0"> <tbody> <tr> <td class="gutter"> <div class="line number1 index0 alt2">1</div> <div class="line number2 index1 alt1">2</div> <div class="line number3 index2 alt2">3</div> <div class="line number4 index3 alt1">4</div> <div class="line number5 index4 alt2">5</div> <div class="line number6 index5 alt1">6</div> <div class="line number7 index6 alt2">7</div> </td> <td class="code"> <div class="container"> <div class="line number1 index0 alt2"><code class="java keyword">class</code> <code class="java plain">Counter</code></div> <div class="line number2 index1 alt1"><code class="java spaces"> </code><code class="java plain">{</code></div> <div class="line number3 index2 alt2"><code class="java preprocessor">/**</code></div> <div class="line number4 index3 alt1"><code class="java spaces"> </code><code class="java preprocessor">* @var</code></div> <div class="line number5 index4 alt2"><code class="java spaces"> </code><code class="java preprocessor">*/</code></div> <div class="line number6 index5 alt1"><code class="java keyword">public</code> <code class="java plain">$var;</code></div> <div class="line number7 index6 alt2"><code class="java spaces"> </code><code class="java plain">}</code></div> </div> </td> </tr> </tbody> </table> </div> </div> <p> </p> <p lang="en-US"> </p> <p lang="en-US">// =============================</p> <p> </p> <p lang="en-US">@version</p> <p lang="en-US"> </p> <p> </p> <div> <div class="syntaxhighlighter java" id="highlighter_221123"> <div class="toolbar"><span><a class="toolbar_item command_help help" href="http://www.2cto.com/kf/201408/322110.html#">?</a></span></div> <table border="0" cellpadding="0" cellspacing="0"> <tbody> <tr> <td class="gutter"> <div class="line number1 index0 alt2">1</div> <div class="line number2 index1 alt1">2</div> <div class="line number3 index2 alt2">3</div> <div class="line number4 index3 alt1">4</div> <div class="line number5 index4 alt2">5</div> <div class="line number6 index5 alt1">6</div> <div class="line number7 index6 alt2">7</div> </td> <td class="code"> <div class="container"> <div class="line number1 index0 alt2"><code class="java preprocessor">/**</code></div> <div class="line number2 index1 alt1"><code class="java spaces"> </code><code class="java preprocessor">* @version 1.0.1</code></div> <div class="line number3 index2 alt2"><code class="java spaces"> </code><code class="java preprocessor">*/</code></div> <div class="line number4 index3 alt1"><code class="java spaces"> </code><code class="java keyword">class</code> <code class="java plain">Counter</code></div> <div class="line number5 index4 alt2"><code class="java spaces"> </code><code class="java plain">{</code></div> <div class="line number6 index5 alt1"><code class="java spaces"> </code><code class="java plain"><...></code></div> <div class="line number7 index6 alt2"><code class="java spaces"> </code><code class="java plain">}</code></div> </div> </td> </tr> </tbody> </table> </div> </div> <p> </p> <p> </p> <p> </p> <div> <div class="syntaxhighlighter java" id="highlighter_740421"> <div class="toolbar"><span><a class="toolbar_item command_help help" href="http://www.2cto.com/kf/201408/322110.html#">?</a></span></div> <table border="0" cellpadding="0" cellspacing="0"> <tbody> <tr> <td class="gutter"> <div class="line number1 index0 alt2">1</div> <div class="line number2 index1 alt1">2</div> <div class="line number3 index2 alt2">3</div> <div class="line number4 index3 alt1">4</div> <div class="line number5 index4 alt2">5</div> <div class="line number6 index5 alt1">6</div> <div class="line number7 index6 alt2">7</div> </td> <td class="code"> <div class="container"> <div class="line number1 index0 alt2"><code class="java preprocessor">/**</code></div> <div class="line number2 index1 alt1"><code class="java spaces"> </code><code class="java preprocessor">* @version GIT: $Id$ In development. Very unstable.</code></div> <div class="line number3 index2 alt2"><code class="java spaces"> </code><code class="java preprocessor">*/</code></div> <div class="line number4 index3 alt1"><code class="java keyword">class</code> <code class="java plain">NeoCounter</code></div> <div class="line number5 index4 alt2"><code class="java plain">{</code></div> <div class="line number6 index5 alt1"><code class="java spaces"> </code><code class="java plain"><...></code></div> <div class="line number7 index6 alt2"><code class="java plain">}</code></div> </div> </td> </tr> </tbody> </table> </div> </div> <p> </p> <p lang="en-US"> </p> </li>