PHP Classes

File: zray/vendor/PHP_CodeSniffer-2.2.0/CodeSniffer/Standards/Squiz/Docs/Commenting/FunctionCommentThrowTagStandard.xml

Recommend this page to a friend!
  Classes of Simo  >  CodeIgniter Plugin for Z-Ray  >  zray/vendor/PHP_CodeSniffer-2.2.0/CodeSniffer/Standards/Squiz/Docs/Commenting/FunctionCommentThrowTagStandard.xml  >  Download  
File: zray/vendor/PHP_CodeSniffer-2.2.0/CodeSniffer/Standards/Squiz/Docs/Commenting/FunctionCommentThrowTagStandard.xml
Role: Auxiliary data
Content type: text/plain
Description: Auxiliary data
Class: CodeIgniter Plugin for Z-Ray
Show CodeIgniter application information in Z-Ray
Author: By
Last change:
Date: 3 months ago
Size: 647 bytes
 

Contents

Class file image Download
<documentation title="Doc Comment Throws Tag">
    <standard>
    <![CDATA[
    If a function throws any exceptions, they should be documented in a @throws tag.
    ]]>
    </standard>
    <code_comparison>
        <code title="Valid: @throws tag used.">
        <![CDATA[
/**
 * <em>@throws Exception all the time</em>
 * @return void
 */
function foo()
{
    throw new Exception('Danger!');
}
]]>
        </code>
        <code title="Invalid: No @throws tag used for throwing function.">
        <![CDATA[
/**
 * @return void
 */
function foo()
{
    throw new Exception('Danger!');
}
]]>
        </code>
    </code_comparison>
</documentation>
For more information send a message to info at phpclasses dot org.