godaddy-wordpress / godaddy-wordpress/php-coding-standards

Comments in between multi-line variable assignments should validate

未关闭
#1 0 条评论 1 个 reaction 已指派 0 人 在 GitHub 查看
主要语言
没有语言数据
星标
0
派生
2
PR 合并指标
30 天内没有已合并 PR

描述

Suppose you have:

```php
// group 1

$foo = 1;
$barbaz = 'variable';
$boo = null;
$anothervar = new \stdClass();

// group 2

// some comment about $foo
$foo = 1;
// some comment about $barbaz
$barbaz = 'variable';
$boo = null;
// some comment about $anothervar
$anothervar = new \stdClass();
```

With the current PHPCS ruleset group 1 would pass but group 2 would not and generate errors.

In my opinion this should be legal for single line small comments to exist in a multi-line group.

I am not sure though that this would be supported by a PHPCS rule. Probably not? Maybe we could turn off spaces before equals sign or set to severity 0. The thing is this pattern often exists in our codebase (for example [here](https://github.com/skyverge/wc-plugins/pull/3359/files#r351621661)). If we have a reason why we allow and like the alignment in group 1, we should allow here as well.

By the way this would also apply to values assignment in arrays:

```php

$my_array = [
'id' => 0,
// some comment about this key:
'name' => 'Foo',
// some comment about this other key
'location' => 123,
'etc' => null,
];
```

贡献指南

这个仓库没有索引到贡献指南

评估

这个 Issue 还没有评估数据。

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。