首页
/ SwiftFormat 中关于 consuming/borrowing 数组参数的空格处理问题解析

SwiftFormat 中关于 consuming/borrowing 数组参数的空格处理问题解析

2025-05-28 20:52:51作者:董宙帆

SwiftFormat 作为 Swift 代码格式化工具,在 0.53.5 版本中存在一个关于 spaceAroundBrackets 规则的误报问题,特别是在处理带有 consumingborrowing 修饰符的数组参数时。

问题现象

当开发者使用如下语法时:

func foo(arg: consuming [String]) {
  // 方法实现
}

SwiftFormat 会错误地报告 spaceAroundBrackets 规则违规,并建议移除 consuming[String] 之间的空格,变成 consuming[String] 这种不符合 Swift 语法规范的格式。

同样的问题也出现在以下情况:

  1. 使用 borrowing 修饰符时
  2. 使用非简写的 Array<String> 语法时

类似问题扩展

在代码审查中还发现了一个相关的问题,当使用 isolated 关键字修饰 Actor 类型时:

func foo(isolation: isolated (any Actor)) {
    // 方法实现
}

SwiftFormat 的 spaceAroundParens 规则会错误地建议移除 isolated 和括号之间的空格。虽然在这个特定例子中括号可以省略,但在 Swift 未来版本中(如支持 SE-420 改进后),当需要表示可选 Actor 类型如 (any Actor)? 时,括号将变得必要。

技术背景

consumingborrowing 是 Swift 中用于内存管理的参数修饰符:

  • consuming 表示函数将取得值的所有权
  • borrowing 表示函数将借用值但不取得所有权

这些修饰符与类型注解之间的空格是 Swift 语法要求的,不应该被移除。SwiftFormat 的规则本应保持这种格式,但在特定情况下出现了误判。

解决方案

该问题已在 SwiftFormat 0.53.6 版本中得到修复。新版本能够正确识别这些特殊情况,不再错误地建议移除必要的空格。

对于开发者来说,建议:

  1. 升级到最新版 SwiftFormat
  2. 在代码中保持 consuming/borrowing 与类型之间的空格
  3. 对于 isolated 关键字,也保持与后续括号之间的空格

最佳实践

当使用 Swift 的这些高级特性时,建议:

  1. 明确参数所有权语义(consuming/borrowing)
  2. 保持代码格式清晰易读
  3. 使用最新版代码格式化工具
  4. 对于特殊语法,手动验证格式化结果是否符合预期

通过保持这些良好的编码习惯,可以确保代码既符合语言规范,又具有良好的可读性。

登录后查看全文
热门项目推荐
相关项目推荐

项目优选

收起
docsdocs
OpenHarmony documentation | OpenHarmony开发者文档
Dockerfile
143
1.91 K
kernelkernel
deepin linux kernel
C
22
6
nop-entropynop-entropy
Nop Platform 2.0是基于可逆计算理论实现的采用面向语言编程范式的新一代低代码开发平台,包含基于全新原理从零开始研发的GraphQL引擎、ORM引擎、工作流引擎、报表引擎、规则引擎、批处理引引擎等完整设计。nop-entropy是它的后端部分,采用java语言实现,可选择集成Spring框架或者Quarkus框架。中小企业可以免费商用
Java
8
0
ohos_react_nativeohos_react_native
React Native鸿蒙化仓库
C++
192
273
RuoYi-Vue3RuoYi-Vue3
🎉 (RuoYi)官方仓库 基于SpringBoot,Spring Security,JWT,Vue3 & Vite、Element Plus 的前后端分离权限管理系统
Vue
927
551
openHiTLSopenHiTLS
旨在打造算法先进、性能卓越、高效敏捷、安全可靠的密码套件,通过轻量级、可剪裁的软件技术架构满足各行业不同场景的多样化要求,让密码技术应用更简单,同时探索后量子等先进算法创新实践,构建密码前沿技术底座!
C
421
392
openGauss-serveropenGauss-server
openGauss kernel ~ openGauss is an open source relational database management system
C++
145
189
金融AI编程实战金融AI编程实战
为非计算机科班出身 (例如财经类高校金融学院) 同学量身定制,新手友好,让学生以亲身实践开源开发的方式,学会使用计算机自动化自己的科研/创新工作。案例以量化投资为主线,涉及 Bash、Python、SQL、BI、AI 等全技术栈,培养面向未来的数智化人才 (如数据工程师、数据分析师、数据科学家、数据决策者、量化投资人)。
Jupyter Notebook
75
64
Cangjie-ExamplesCangjie-Examples
本仓将收集和展示高质量的仓颉示例代码,欢迎大家投稿,让全世界看到您的妙趣设计,也让更多人通过您的编码理解和喜爱仓颉语言。
Cangjie
344
1.3 K
easy-eseasy-es
Elasticsearch 国内Top1 elasticsearch搜索引擎框架es ORM框架,索引全自动智能托管,如丝般顺滑,与Mybatis-plus一致的API,屏蔽语言差异,开发者只需要会MySQL语法即可完成对Es的相关操作,零额外学习成本.底层采用RestHighLevelClient,兼具低码,易用,易拓展等特性,支持es独有的高亮,权重,分词,Geo,嵌套,父子类型等功能...
Java
36
8