~ubuntu-branches/ubuntu/vivid/php-codesniffer/vivid

« back to all changes in this revision

Viewing changes to PHP_CodeSniffer-1.5.5/CodeSniffer/Standards/Generic/Docs/Formatting/MultipleStatementAlignmentStandard.xml

  • Committer: Package Import Robot
  • Author(s): David Prévot, Greg Sherwood, Alexey, Emily, David Prévot
  • Date: 2014-09-26 13:44:35 UTC
  • mfrom: (1.1.6)
  • Revision ID: package-import@ubuntu.com-20140926134435-wvjq16miqq4d60y0
Tags: 1.5.5-1
[ Greg Sherwood ]
* Improved closure support in Generic ScopeIndentSniff
* Improved indented PHP tag support in Generic ScopeIndentSniff
* Standards can now be located within hidden directories
 (further fix for bug #20323)
* Fixed bug #20373 : Inline comment sniff tab handling way
* Fixed bug #20378 : Report appended to existing file if no errors
  found in run
* Fixed bug #20381 : Invalid "Comment closer must be on a new line"
* PHP tokenizer no longer converts class/function names to special
  tokens types
* Fixed bug #20386 : Squiz.Commenting.ClassComment.SpacingBefore
  thrown if first block comment
* Squiz and PEAR FunctionCommentSnif now support _()
* PEAR ValidFunctionNameSniff no longer throws an error for _()
* Fixed bug #248 : FunctionCommentSniff expects ampersand on param name
* Fixed bug #248 in Squiz sniff as well
* Fixed bug #265 : False positives with type hints in ForbiddenFunctionsSniff
* Prepare for 1.5.5 release

[ Alexey ]
* Allowed single undersored methods and functions

[ Emily ]
* Added var_dump to discouraged functions sniff

[ David Prévot ]
* Revert "Add XS-Testsuite still needed for ci.d.n"
* Add self to uploaders
* Bump standards version to 3.9.6

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
<documentation title="Aligning Blocks of Assignments">
 
2
    <standard>
 
3
    <![CDATA[
 
4
      There should be one space on either side of an equals sign used to assign a value to a variable. In the case of a block of related assignments, more space may be inserted to promote readability.
 
5
    ]]>
 
6
    </standard>
 
7
    <code_comparison>
 
8
        <code title="Equals signs aligned">
 
9
        <![CDATA[
 
10
$shortVar        <em>=</em> (1 + 2);
 
11
$veryLongVarName <em>=</em> 'string';
 
12
$var             <em>=</em> foo($bar, $baz, $quux);
 
13
        ]]>
 
14
        </code>
 
15
        <code title="Not aligned; harder to read">
 
16
        <![CDATA[
 
17
$shortVar <em>=</em> (1 + 2);
 
18
$veryLongVarName <em>=</em> 'string';
 
19
$var <em>=</em> foo($bar, $baz, $quux);
 
20
        ]]>
 
21
        </code>
 
22
    </code_comparison>
 
23
    <standard>
 
24
    <![CDATA[
 
25
      When using plus-equals, minus-equals etc. still ensure the equals signs are aligned to one space after the longest variable name.
 
26
    ]]>
 
27
    </standard>
 
28
    <code_comparison>
 
29
        <code title="Equals signs aligned; only one space after longest var name">
 
30
        <![CDATA[
 
31
$shortVar       <em>+= </em>1;
 
32
$veryLongVarName<em> = </em>1;
 
33
        ]]>
 
34
        </code>
 
35
        <code title="Two spaces after longest var name">
 
36
        <![CDATA[
 
37
$shortVar       <em> += </em>1;
 
38
$veryLongVarName<em>  = </em>1;
 
39
        ]]>
 
40
        </code>
 
41
    </code_comparison>
 
42
    <code_comparison>
 
43
        <code title="Equals signs aligned">
 
44
        <![CDATA[
 
45
$shortVar       <em>  = </em>1;
 
46
$veryLongVarName<em> -= </em>1;
 
47
        ]]>
 
48
        </code>
 
49
        <code title="Equals signs not aligned">
 
50
        <![CDATA[
 
51
$shortVar       <em> = </em>1;
 
52
$veryLongVarName<em> -= </em>1;
 
53
        ]]>
 
54
        </code>
 
55
    </code_comparison>
 
56
</documentation>