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

[Contributing] [Standards] Added entry for identical comparison #5403

Closed
wants to merge 6 commits into from
Closed

[Contributing] [Standards] Added entry for identical comparison #5403

Changes from 2 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
b0055ed
[Contributing] [Conventions] Added entry for identical comparison
phansys Jun 15, 2015
fc350ca
Moved strict comparison doc from conventions to standards.
phansys Jun 15, 2015
ef30569
Updated message enforcing always to use strict comparison.
phansys Jun 16, 2015
b0a441f
Mixed both snippets in just one.
phansys Jun 16, 2015
b648da8
Updated markdown delimiter for code snippet.
phansys Jun 16, 2015
c073821
Moved "comparisons" inside "structure".
phansys Jun 26, 2015
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
24 changes: 24 additions & 0 deletions contributing/code/standards.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -167,6 +167,29 @@ Service Naming Conventions

* A group name uses the underscore notation.

.. _contributing-code-standards-comparisons:

Comparisons
-----------

Use `identical comparison`_ when the expected value must match a specific type:
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would go further and recommend to always use the identical comparison unless you have a strong reason to not do that. @wouterj @xabbuh what do you think?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I asked the same previously (which disappeared when moving the note to a different page)

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is the original note from @stof about identical comparison.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I agree, should be something like "Always use strict comparison unless you need type juggling".


instead of:
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

should be removed

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good catch @xabbuh, removed.


.. code-block:: php
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

you can omit this if you use a double colon at the end of the line before

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I saw that syntax before, but what about specific code highlighting for PHP?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

PHP is the default syntax highlighting. So it's used in that case.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Updated.


if (1 == $integerExpected) {
// ...
}

it should be:

.. code-block:: php

if (1 === $integerExpected) {
// ...
}
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What about using one code block for this to make it more compact?

Always use `identical comparison`_ unless you need type juggling::

    // use
    if (1 === $integerExcepted) {
        // ...
    }

    // instead of
    if (1 == $integerExcepted) {
        // ...
    }

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Seems good to me @xabbuh.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Updated.


Documentation
-------------

Expand All @@ -186,3 +209,4 @@ License
.. _`PSR-1`: http://www.php-fig.org/psr/psr-1/
.. _`PSR-2`: http://www.php-fig.org/psr/psr-2/
.. _`PSR-4`: http://www.php-fig.org/psr/psr-4/
.. _`identical comparison`: https://php.net/manual/en/language.operators.comparison.php