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

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

项目分组

如果项目比较大,建议把几个模块拆分后类似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开发编码规范

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 194,491评论 5 459
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 81,856评论 2 371
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 141,745评论 0 319
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 52,196评论 1 263
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 61,073评论 4 355
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 46,112评论 1 272
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 36,531评论 3 381
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 35,215评论 0 253
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 39,485评论 1 290
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 34,578评论 2 309
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 36,356评论 1 326
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 32,215评论 3 312
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 37,583评论 3 299
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 28,898评论 0 17
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 30,174评论 1 250
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 41,497评论 2 341
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 40,697评论 2 335

推荐阅读更多精彩内容

  • iOS编程规范0规范 0.1前言 为􏰀高产品代码质量,指导广大软件开发人员编写出简洁、可维护、可靠、可 测试、高效...
    iOS行者阅读 4,418评论 21 35
  • Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具(例如配置管理,服务发现,断路器,智...
    卡卡罗2017阅读 134,497评论 18 139
  • 禅与 Objective-C 编程艺术 (Zen and the Art of the Objective-C C...
    GrayLand阅读 1,595评论 1 10
  • 春天暖起来,我该出来运动了,毕竟冬眠了三个月。 我用关键字“上海 跑步”搜QQ群,跑步群不计其数,还有分地域范围的...
    大嘴堂阅读 512评论 0 0
  • 2017年1月5日,拳王邹市明的妻子冉莹颖晒出一张手指被戒指卡住的照片,附文称“越脱越肿请教万能的微博达人们”。 ...
    珠宝大课堂阅读 935评论 0 2