Hacktoberfest 2026:维护者为十月标记出来的 issue,仍然开放、适合新手。 浏览 Hacktoberfest issue

Comments in between multi-line variable assignments should validate

未关闭
#1 0 条评论 1 个 reaction 已指派 0 人 在 GitHub 查看

还没有人认领这个 Issue。

评估

难度
4/5
预计耗时
3-5 天
新手友好度
35/100
Issue 类型
缺陷
描述清晰度
基本清楚
活跃度
停滞
技术栈
php
领域
tooling

调研方向

首先复现针对多行赋值和数组示例所报告的 PHPCS 错误,然后检查强制等号前空格的 ruleset 或规则。issue 未指定文件或测试;当对齐的赋值和数组项之间的注释能够通过验证,同时继续强制执行现有对齐方式时,即表示完成。

由索引模型根据 Issue 内容生成。

描述

Suppose you have:

// 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). 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:


$my_array = [
	'id'       => 0,
	// some comment about this key:
	'name'     => 'Foo',
    // some comment about this other key
	'location' => 123,
	'etc'      => null,
];
主要语言
没有语言数据
星标
0
派生
2
PR 合并指标
30 天内没有已合并 PR

环境准备

这个项目没有提供开发容器、Dockerfile 或贡献指南,环境需要你自己搭建:先看它的 README,通用步骤见我们的新手贡献指南。

从这里开始

  1. 先读完整个 Issue,再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 Issue 编号。

相似的 Issue

更多 DevTools Issue

把新 issue 发到你的邮箱

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