Fixed code examples

[wouterj]

This should be merged into the 2.0 branch, NOT the master branch. Excuse me for this mistake.

The code examples on the documentation where a little messy. I have changed all code examples to follow these rules:

Rules

• The code follows the Coding Standards, the Symfony Coding Standards as well as the Twig Coding Standards.
• When we fold one or more lines of code we place ... in a comment at the point where we fold some code. These comments are: // ... (php), # ... (yaml), {# ... #} (twig), <!-- ... --> (xml/html), ; ... (ini), ... (text)
• When we fold a part of a line, e.g. a variable value, we put ... (without comment) at the place of the fold.
• Description about the fold: (optional)
  
  If we fold some lines: The description can be placed after the ...
  
  If we fold a part of a line: The description can be placed before the line
• If usefull, a codeblock begins with a comment with the filename. After this file comment should not be a blank line, except if the next line is a comment too

A very simple example:

// src/Foo/Bar/foo.php
function foo($bar) 
{
    // set foo with a value of bar
    $foo = ...;

    // ... check if $bar has the correct value

    return $foo->baz($bar);
}

Some rules that I haven't included, because it need some more discussion:

• Do we use the sorthand :: or the codeblock .. code-block:: php for php code?
• Do we put a $ before every bash line?

Points of attention

• You should to put a space after { and before } in Yaml (e.g. { _controller: ... }), but this should not be done in Twig (e.g. {'hello' : 'value'}).

• An array item is a piece of a line, not a total line. So don't use // ... but ..., (the comma because of the Coding Standards):

  array(
      'some value',
      ...,
  )
  

Because I have seen hunderts lines of code it is sure that I have missed some mistakes, so feel free to solve it or place a comment so I can solve it.

[weaverryan]

Hey!

I see that you already noticed #1534, which I just merged into 2.0. Can you rebase your commits to include the latest and also make a new PR to the 2.0 branch? You mentioned that this should be merged into the 2.0 branch, but it'll be much easier to review if the PR is against 2.0 since the changeset is so heavy.

Thank you!

[wouterj]

I have created a new PR: #1548