Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[Documentation] Squiz: Function Spacing #451

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

[Documentation] Squiz: Function Spacing #451

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
185 changes: 185 additions & 0 deletions src/Standards/Squiz/Docs/WhiteSpace/FunctionSpacingStandard.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,185 @@
<documentation title="Function Spacing">
<standard>
<![CDATA[
There should be exactly 2 blank lines before a function within a statement group or control structure when it is the first block of code.
]]>
</standard>
<code_comparison>
<code title="Valid: Exactly 2 blank lines before the first function.">
<![CDATA[
class MyClass
{<em>


</em> public function foo() {
}


}
]]>
</code>
<code title="Invalid: Too few blank lines before the first function.">
<![CDATA[
class MyClass
{<em>

</em> public function foo() {
}


}
]]>
</code>
</code_comparison>
<code_comparison>
<code title="Valid: Exactly 2 blank lines before the first function.">
<![CDATA[
if ($something) {<em>


</em> function foo() {
}


function bar() {
}


}
]]>
</code>
<code title="Invalid: Too many blank lines before the first function.">
<![CDATA[
if ($something) {<em>



</em> function foo() {
}


function bar() {
}


}
]]>
</code>
</code_comparison>
<standard>
<![CDATA[
There should be exactly 2 blank lines before and after a function declaration.
]]>
</standard>
<code_comparison>
<code title="Valid: Exactly 2 blank lines before and after function declarations.">
<![CDATA[
interface MyInterface
{


public function foo();<em>


</em> public function bar();<em>


</em> public function baz();


}
]]>
</code>
<code title="Invalid: Incorrect number of blank lines before/after function declarations.">
<![CDATA[
interface MyInterface
{


public function foo();<em>
</em> public function bar();<em>



</em> public function baz();


}
]]>
</code>
</code_comparison>
<standard>
<![CDATA[
There should be exactly two blank lines after a function within a statement group or control structure when it is the last block of code.
]]>
</standard>
<code_comparison>
<code title="Valid: Exactly 2 blank lines after the last function.">
<![CDATA[
trait MyTrait
{


public function foo() {
}


public function bar() {
}<em>


</em>}
]]>
</code>
<code title="Invalid: Too few blank lines after the last function.">
<![CDATA[
trait MyTrait
{


public function foo() {
}


public function bar() {
}<em>
</em>}
]]>
</code>
</code_comparison>
<code_comparison>
<code title="Valid: Exactly 2 blank lines after the last function.">
<![CDATA[
if ($something) {


function foo() {
}


function bar() {
}<em>


</em>}
]]>
</code>
<code title="Invalid: Too many blank lines after the last function.">
<![CDATA[
if ($something) {


function foo() {
}


function bar() {
}<em>



</em>}
]]>
</code>
</code_comparison>
</documentation>