兄弟,你甚至连SwiftLint吗?
遵循准则或样式代码约定编写代码应该是您的核心实践之一。 而且我知道有时是不自觉的,或者是因为匆忙中我们在这里到处都是小事:方法实现时间太长,代码行很长,双折行,逗号后没有空格, ->
…之间没有分隔,今天,我将写有关SwiftLint的工具,该工具将在编写代码时帮助我们强制执行样式和约定。
SwiftLint是Realm的一种工具,大致基于GitHub的Swift样式指南,用于实施Swift样式和约定。
使用SwiftLint可以帮助您接受样式和代码约定,这将为您带来一些好处,例如:
- 您的代码将更加清晰易读
- 您的代码将更具可维护性和可扩展性
- 您的代码将易于测试和调试
- 您将在所有项目中保持代码一致性
SwiftLint将检查您的代码,并识别语法和样式错误。 您将能够轻松地识别出这些内容,因为在编写代码时,您会在Xcode中看到类似的内容。
您可以通过几种方式安装SwiftLint,但我个人很喜欢使用CocoaPods方式。 当您与团队合作时,它特别方便,并且是安装特定版本的SwiftLint的推荐方法,因为它支持安装固定版本而不是简单版本(Homebrew就是这种情况)。
要将SwiftLint与CocoaPods一起安装:
- 只需将以下行添加到您的Podfile中:
吊舱“ SwiftLint”
2.在Xcode项目中添加新的“运行脚本阶段”,内容如下:
“ $ {PODS_ROOT} / SwiftLint / swiftlint”
SwiftLint有超过75条规则,您可以在此处查看列表。
好处是,您可以控制启用或禁用哪个规则,并可以为给定规则设置警告和错误的阈值。 只需在项目目录中添加.swiftlint.yml
文件即可。 您可以在这里看到更多信息。
仅供参考:您可以在此处看到我预定义的.swiftlint.yml
文件。
启用代码中的禁用规则
如果要启用或禁用特定于行或文件的规则,则可以使用某些功能。
可以通过以下格式在源文件中添加注释来禁用规则:
// swiftlint:disable [ ...]
规则将一直禁用,直到文件末尾或短绒棉纸看到匹配的启用注释:
// swiftlint:enable [ ...]
也可以通过添加:previous
, :this
或:next
来修改disable
或enable
命令,以仅将命令分别应用于上一行,本行(当前)或下一行。
// swiftlint:disable:next
// swiftlint:disable:this
// swiftlint:disable:previous
在这里查看更多。
资料来源和阅读建议:
- SwiftLint GitHub
- 注意您的语言!”使用SwiftLint的清洁代码之路
任何傻瓜都可以编写计算机可以理解的代码。 好的程序员编写人类可以理解的代码。
—马丁·福勒
我希望您喜欢这篇文章并觉得它有用。 并且不要伪造总是一个好的程序员。 感谢您阅读️!