Drupal.Commenting.VariableComment.VarOrder - @var before @code

/** * Array of fields to update to an expression in case of a duplicate record. * * This variable is a nested array in the following format: * @code * <some field> => array( * 'condition' => <condition to execute, as a string>, * 'arguments' => <array of arguments for condition, or NULL for none>, * ); * @endcode * * @var array */

* @link http://github.com/zendframework/zf2 for the canonical source repository * @copyright Copyright (c) 2005-2013 Zend Technologies USA Inc. (http://www.zend.com) * @license http://framework.zend.com/license/new-bsd New BSD License * * A map of characters to be replaced through strtr. * * @var array

Comments & Activities

Not all content is available!

It's likely this issue predates Contrib.social: some issue and comment data are missing.

Comment 4 months ago →
🇳🇿New Zealand quietone
I worked on the core issue 📌 Fix 'Drupal.Commenting.VariableComment.VarOrder' coding standard Postponed today and reporting back here.

The Drupal coding standards page api-documentation-and-comment-standards#order does not mention @code in the order of sections. Should it be considered a section?

Can make an in issue in the Coding Standards project so that can be discussed.

Core does not have any '@copyright' or '@license' in doc blocks. So, that point seems to be outdated.

And '@link .. @endlink' is reported as an error. But I think this is correct for the Variable comment block where the explanation is after @var.

Also, there were no instances in Drupal core where an '@link .. @endlink' was moved as a result of enabling the sniff.

So, for me I would go with won't fix on this.
Status changed to Closed: won't fix 4 months ago9:29am 3 August 2024
Comment 4 months ago →
🇦🇹Austria klausi 🇦🇹 Vienna
I agree - and I don't think we will need @var comments in the future as now you must always specify the type of your class property as type hint (at least for new code). Eventually we can remove the @var coding standard and enforce property type hints with a sniff from Slevomat.