PHP Classes

File: zray/vendor/PHP_CodeSniffer-2.2.0/CodeSniffer/Standards/Squiz/Docs/Commenting/DocCommentAlignmentStandard.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/DocCommentAlignmentStandard.xml  >  Download  
File: zray/vendor/PHP_CodeSniffer-2.2.0/CodeSniffer/Standards/Squiz/Docs/Commenting/DocCommentAlignmentStandard.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: 845 bytes
 

Contents

Class file image Download
<documentation title="Doc Comment Alignment">
    <standard>
    <![CDATA[
    The asterisks in a doc comment should align, and there should be one space between the asterisk and tags.
    ]]>
    </standard>
    <code_comparison>
        <code title="Valid: Asterisks are aligned.">
        <![CDATA[
/**
<em> </em>* @see foo()
<em> </em>*/
]]>
        </code>
        <code title="Invalid: Asterisks are not aligned.">
        <![CDATA[
/**
<em>  </em>* @see foo()
<em></em>*/
]]>
        </code>
    </code_comparison>
    <code_comparison>
        <code title="Valid: One space between asterisk and tag.">
        <![CDATA[
/**
 *<em> </em>@see foo()
 */
]]>
        </code>
        <code title="Invalid: Incorrect spacing used.">
        <![CDATA[
/**
 *<em>  </em>@see foo()
 */
]]>
        </code>
    </code_comparison>
</documentation>
For more information send a message to info at phpclasses dot org.