为扩展现有对象的 Swift 文件命名,最佳实践是什么?


并没有一个单一的“最佳”实践来命名扩展现有对象的 Swift 文件,但以下是一些常用的约定:

对象前缀后跟功能

  • String+Utilities.swift − 为 String 类添加实用程序函数

  • Array+Sorting.swift − 为 Array 类添加排序函数

  • UIColor+Extensions.swift − 为 UIColor 类添加颜色相关的函数

功能前缀后跟对象

  • CustomView+Animation.swift − 为名为 CustomView 的自定义视图类添加动画功能

  • JSONEncoder+CustomEncoding.swift − 为 JSONEncoder 类添加自定义编码和解码功能

  • UICollectionViewLayout+Extensions.swift − 为 UICollectionViewLayout 类添加布局相关的函数

描述性命名

  • Date+ISO8601String.swift − 为 Date 类添加处理 ISO 8601 格式字符串的函数

  • UIImage+Manipulation.swift − 为 UIImage 类添加图像处理函数

  • URLSession+Retry.swift − 为 URLSession 类添加使用重试失败网络请求的功能

以下是一些在命名扩展现有对象的 Swift 文件时需要考虑的其他要点:

  • 精确且具有描述性 − 为文件赋予一个准确反映其目标的名称。描述性名称有助于其他编写者理解文件的作用,而无需阅读代码。

  • 保持统一的命名约定 − 选择一种模式并在整个软件中一致地使用它。这使得程序员更容易找到相关的文件,并确保软件井井有条且易于理解。

  • 避免使用缩写 − 虽然它们看起来很方便,但缩写可能会令人困惑且难以理解。使用完整的单词来准确地解释新功能。

  • 选择简短且简单的名称 − 文件名应该易于编写、阅读和记住。避免名称过长或难以发音。

  • 用“+”号分隔项目和扩展名 − 为扩展现有对象的命名文件时,“加号”区分对象名称和扩展名。例如 String+Utilities.swift。

  • 为了避免命名冲突,如果您正在扩展一个已经具有相同名称扩展名的对象,请选择一个替代名称。

结论

通过遵循良好且正确的命名约定,您可以正确地组织文件。这将帮助您轻松地处理和修改扩展。当我们处理包含许多扩展文件的大型项目时,命名约定非常重要。

更新于:2023年5月4日

801 次浏览

启动您的 职业生涯

通过完成课程获得认证

开始
广告
© . All rights reserved.