一些规范

木木木大约 3 分钟iOS

一些规范

iOS开发中,规范的编码方式和风格可以使代码更加清晰易读、易于维护。

代码组织

文件名

  • 文件名应该清晰明了,使用驼峰命名法,以首字母大写的类名为准。
  • 对于 UIKit 和 Foundation 框架提供的类的扩展,应该以 + 为前缀,例如 String+Extension.swift。

代码结构

  • 文件应该按照逻辑组织代码,不要将过多的代码放在一个文件中。
  • import 应该按照字母顺序排列,分组放置。系统框架应该在第一组。
  • 代码应该按照生命周期的顺序进行编写:先是属性和初始化方法,接着是 viewDidLoad(),然后是其他的生命周期方法,最后是自定义的方法。

代码风格

缩进和空格

  • 每次缩进使用4个空格,而不是Tab。
  • 代码行末不应该有空格。
  • if 和 else 的语句应该在同一行,花括号则应该另起一行。
  • 冒号前不应该有空格,后面应该有一个空格。
  • 函数名和括号之间不应该有空格,括号内的参数名和冒号之间应该有一个空格。

命名规范

  • 变量、常量、函数、方法应该使用驼峰命名法。
  • 类型、协议、枚举应该使用大驼峰命名法。
  • 缩写应该全部大写或者全部小写。
  • 变量和常量应该以名词作为前缀,例如 myString。
  • 函数和方法应该以动词作为前缀,例如 startAnimating()。

注释

  • 代码应该有必要的注释,解释代码的目的和工作原理。
  • 注释应该放在代码上面,而不是后面。
  • 注释应该清晰、简洁和易于理解。

括号

  • 所有的代码块都应该使用花括号,即使只有一行代码。
  • 开始花括号应该和代码块在同一行,结束花括号应该单独一行。
  • 如果代码块包含多行语句,结束花括号应该与代码块的开头对齐。

函数

  • 函数应该足够短小,只做一件事情。
  • 函数应该遵循单一职责原则(SRP),即只有一个原因可以导致函数进行更改。
  • 参数应该尽可能少,最好不超过三个。如果需要很多参数,请考虑使用一个参数对象。

引用

  • 当使用强引用时,应该考虑避免循环引用。
  • 对于循环引用,请使用弱引用或无主引用来打破引用环。

类型推断

  • 尽可能使用类型推断来提高代码的可读性和简洁性。
  • 在需要时,可以显式声明变量、常量和函数的类型。
  • 对于一些特殊的情况,如CGFloat等,需要注意使用正确的类型。

访问控制

  • 对于每个属性和方法,应该考虑使用适当的访问控制。
  • 尽可能使用最小限度的访问控制来限制对代码的访问。

错误处理

  • 对于可能出现错误的操作,应该考虑使用try-catch语句来处理错误。
  • 对于可能引发多个错误的操作,应该使用do-catch语句来处理错误。
上次编辑于:
贡献者: perhapsdone