[policy] Coding standards for "use" statements [#1791928]

Proposed solution

use statements MUST be located after the initial @file phpDoc block.
use statements SHOULD be "ordered by":
1. (FullyQualifiedClassName == framework/vendor namespace)
2. FullyQualifiedClassName

Example


/**
 * @file
 * Contains Drupal\node\Node.
 */

namespace Drupal\node;

use Drupal\Component\Uuid\Uuid;
use Drupal\Core\Entity\EntityFieldQuery;
use Symfony\Component\HttpKernel\Exception\AccessDeniedHttpException;
use Symfony\Component\HttpKernel\Exception\NotFoundHttpException;
use Drupal\file\File;
use Drupal\user\User;

Comments

Comment #1

Lars Toomre CreditAttribution: Lars Toomre commented 21 September 2012 at 22:00

Wonderful... What is the Drupal policy? Alphabetical order?

Comment #2

Crell CreditAttribution: Crell commented 21 September 2012 at 23:55

There is currently no Drupal policy. I couldn't find the previous issue where this was discussed and ended up with a general "meh".

Most of my code has been putting all Symfony classes together in one block, then all Drupal stuff together in a separate block, ordered roughly by component/subsystem. I don't know that a hard alphabetical order is necessary; it's not like it actually means anything to the compiler either way, and we're not going to be doing deployment based on the diffs (like for CMI objects).

Comment #3

Anonymous (not verified) CreditAttribution: Anonymous commented 22 September 2012 at 06:19

This was also discussed here: #1624564: Coding standards for "use" statements

Personally, I like the suggestion as the code looks cleaner (to me), but the issue that was raised there was more that it's another coding standards issue to enforce, and that some people may be resistant.

If there are starting to be large numbers of these, though, I would prefer a standard.