不需要注释就能轻松读懂的代码,使用的语言特性也必然是通用和经典的,过新的语言特性和黑魔法不利于代码逻辑的阅读,应该减少使用,即使使用也需要多加注释,避免他人无法理解。
么,怎么做Code Review 会比较好呢?
首先,我觉得要利用好 Code Review 这个卡点,先使用静态检查工具对提交的代码进行一次全面检查。
如果是 Swift 语言的话,你可以使用 SwiftLint工具来检查代码规范。Swift 通过 Hook Clang 和 SourceKit 中 AST 的回调来检查源代码,如何使用SourceKit 开发工具可以参看这篇文章“Uncovering SourceKit”。
SwiftLint 检查的默认规则,你可以参考它的规则说明。SwiftLint 也支持自定义检查规则,支持你添加自己制定的代码规范。你可以在 SwiftLint 目录下添加一个 .swiftlint.yml 配置文件来自定义基于正则表达式的自定义规则。具体方法,你可以参看官方定义自定义规则的说明。
如果你是使用 Objective-C 语言开发的话,可以使用 OCLint 来做代码规范检查。关于 OCLint 如何定制自己的代码规范检查,你可以参看杨萧玉的这篇博文“使用 OCLint 自定义 MVVM 规则”。
网友评论