欢迎您访问程序员文章站本站旨在为大家提供分享程序员计算机编程知识!
您现在的位置是: 首页

致iOS初学者的建议--编程规范与风格

程序员文章站 2022-03-31 09:38:14
...

每个初学者貌似都是拿到编程入门就开始撸语法编程技巧等,要知道编程规范性也是一个很重要的点,而且,好的编程规范性或者统一的编程风格会让你的代码更具可阅读性与维护性,这就跟从读书开始老师就经常叮嘱字写得整齐好看的重要性。总之就是,风骚与效率并行(-.-)。个人建议在边开始学习语法内容的时候也要边注意下编程规范与编程风格。每个公司都有不同的编程风格要求,不过也大多差别不会很大。

项目分组

如果项目比较大,建议把几个模块拆分后类似Pod的结构组合在一起,普通工程用主Project+Pod即可。项目组织结构可类似如下:

/$Pod(可选)
/$Target
  /Main: AppDelegate以及Main等
  /Cells: 通用Cell
  /Views: 视图类(按功能分组)
  /ViewController: 控制器(按功能分组)
  /Utils: 工具类
  /Categories: 类拓展
  /Managers: 数据业务管理类
  /Model: 模型文件
  /Vendors: 第三方库
  /Resources: 资源文件
  /Others: pch等文件   
  • Cells:如果是特定Cell只用在某个TableView,可写在同一个包括了TableView的类里
  • Categories: 建议不要分散太多文件,可写在同一个类似"NSObject+Categories.h"的类里,然后按功能划分成多个类。
  • Managers: 如果使用MVVM模式可划分为DataManager、CoreDataManager、NetworkManager等
  • Models: 普通模型文件/CoreData实体模型文件等
  • Resources: 放置图片与plist等设置文件,可按功能分组。

注:项目文件分组建议建立相应的物理文件夹

代码格式

注释

编写注释文档是个好习惯。不仅有助于他人理解你的代码,如果是多人开发的话,也有助于你自己回过头去看代码。在接口方法、类属性、实例变量、宏、枚举值等都应该编写注释文档,另外,在关键代码或者难理解的地方也建议应该编写注释。
Tips: VV-Document插件可以快速地生成注释文档格式。

命名

  • 使用简洁明了的命名,建议使用驼峰式命名,属性与方法使用小驼峰,类名使用大驼峰。
  • 项目内文件使用统一前缀,与系统框架区分开。建议使用三个字母前缀。
  • 实例变量命名使用_前缀

注意:非初始化方法建议不使用init前缀,非需要自行管理内存的不使用create前缀,变量属性不使用new前缀,初始化方法等建议返回instancetype

宏与常量

避免使用宏,简单的数量等建议直接使用常量。全局宏按功能统一定义在全局头文件,全局常量也建议定义在同一个或者几个文件,可按功能划分开。内部常量用小写k+类名做前缀,外部常量用类名做前缀

  • 内部常量,格式参考:
CGFloat const kTHKAlertViewContentViewHeight = 200.0f;
  • 外部常量,格式参考:
在.h定义:
extern NSString * const THKUserDidLoginNotification;

在.m中实现:
NSString * const THKUserDidLoginNotification = @"THKUserDidLoginNotification";

声明

声明所在的接口应当尽量简单,合模块的功能尽量保持单一,这样能够尽可能地减少模块之间的耦合程度也减少不必要的干扰,所以属性以及方法在非必要的情况下不暴露到头文件。

  • 实例变量仅在需要暴露给子类的时候在头文件上使用@protected。
  • 属性若非必要的情况,声明为readonly。
  • 一般只暴露immutable类型的属性。
  • 枚举值使用NS_ENUM。

编码风格

建议在项目里保持一种编码风格,这样不仅有助于代码的维护也有助于他人阅读代码。要不然你一种风格我一种风格,多人合作的时候会使得代码看起来很混乱。在必要的地方要用空格分隔开,这样也使得代码,唔,更为好看风骚。其实个人更建议按照Apple自动生成的代码风格去进行编码,更能保持一致性。

实例变量或属性:

NSObject *_object;
@property (nonatomic, strong) NSObject *object;

或者

NSObject * _object;
@property (nonatomic, strong) NSObject * object;

方法:括号可以保持各占一行上下对齐或者左括号在方法一行,右括号占一行。-号、+号与方法返回值之间应该有一个空格。如果左括号在方法一行,与最后的方法名之间也应该有一个空格。

- (void)viewDidLoad()
{
}
+ (void)load
{
}
[[THKAlertView shareInstance] show];//疏散型

或者

- (void)viewDidLoad() {
}
+ (void)load {
}
[[THKAlertView shareInstance]show];//紧密型

控制流:同方法一样,主要是括号的风格,如果是第一种建议也要用一下空格分隔下代码。

if (statement) {
} else if (statement) {
} else {
}

switch (statement) {
    case type1: {
        break;
    }
    case type2: {
        break;
    }
    default: {
        break;
    }
}

for (statement) {
}

或者

if (statement)
{
}
else if (statement)
{
}
else
{
}

switch (statement)
{
    case type1:
    {
        break;
    }
    case type2:
    {
        break;
    }
    default:
    {
        break;
    }
}

for (statement)
{
}

注:控制流的括号建议不要省,如果代码很少可以都放在一行。但是,不要省略。

我是觉得按照Apple自动生成的代码风格作为自己的基础编程风格是个比较好的习惯。

上面就粗略地讲了部分基本的,详细的既然有很好的版本这里就不赘述了。(我们不生产鸡汤,我们只是大自然的搬运工 *_*)
附上几篇比较好的文档:
Apple: Coding Guidelines for Cocoa
Google: Objective-C Style Guide
Cocoachina: Objective-C开发编码规范