iOS 代码规范总结

前言:代码规范最终的目的是降低代码维护的成本。

代码规范的好处(网上一搜一大把):http://kdboy.iteye.com/blog/407572

一. 结构规范

1.文件夹的建立:注意创建的都是实体文件夹 参考链接http://blog.csdn.net/lvxiangan/article/details/21228215

2. MVC 三个文件夹 : Controller  View  Model

 通常View 下面会有Cell 文件夹  Model 下会有Biz (业务处理类: 请求接口 组织数据)和 Entity(实体类)

MVC 目录结构

3.继承关系

    Controller 继承一个自定义的UIViewContrller  eg:EMSuperVC

    View        继承一个自定义的UIView eg:EMSuperView

   自定义cell 继承UITableViewCell

4.类中源文件中的方法布局

    1. 构造函数 (init)

   2.  父类方法

   3.   公共方法public method

   4.    代理方法  delegate

   5.响应事件response events

   6.    私有方法privatelymethod

   7.    get set 方法

他们之间需要用#pragma mark - XXX 分开  使布局清晰

每个类型中的多个方法通过#pragma mark ------ zs20170716XXX 注释方便查找方法

5.MVC 之间的通信

   Controller - > View   调用View 提供的public method   千万不要为了省事将VIew 的私有属性公开   后期维护成本太大  耦合性太大

    View - >Controller  block  回调

    Controller -> Model  调用Model 提供的public method

    Model - > Controller   delegate 传值

6.类的导入:在源文件中导入类,头文件中用@class  声明类

7.每个函数方法的限制

     7.1 每个方法只做一件事

      7.2 行数要进行限制

8.方法的花括号另起一行,结构块花括号尾随语句之后

示例图

二.命名规则 总体必须遵从驼峰法则

1.类的命名

所有的类名均以EM开头  (公司名简称)

Controller : EM + 类描述 + VC

VIew         :    EM + 类描述 + VIew

Model 中 Entity  :    EM + 类描述 + 后台返回数据生成的字段

Model 中  Biz     :    EM + 类描述 + Biz

类的命名示例

2.属性的命名 (变量的命名)

    @property(nonatomic,strong) EMWalletView *viewWallet;

    2.1小括号前后有空格

    2.2 *与类名之间有空格 和属性命名之间无空格

    2.3 UI类的命名:

           2.3.1 UILable *labTitle;

          2.3.2 UIView  *viewBack;

         2.3.3 UIButton *btnPay;

         2.3.4 UITextField  *tFLogin;

         2.3.5 EMWalletView *viewWallet;

2.4 Controller 中的属性命名举例

       @property(nonatomic,strong) EMTransactionRecordView *viewTransactionRecord;主View

       @property(nonatomic,strong) EMTransactionRecordBiz *bizTransactionRecord; 

2.5 View中Block 的定义和命名

block定义:类名 + Block 进行命名

eg:

属性命名:block + 去掉EM的类名

eg:

3.刷新方法的命名

- (void)reloadTableViewWithDataSource:(EMTradeRecordBaseClass*)entityTradeRecord;

- (void)reloadCellMessageWithDataSource:(EMTradeRecordList*)entityTradeRecord;

4.Biz中代理(delegate)协议的命名

协议的命名: 类名+Delegate eg:EMTransactionRecordBizDelegate

设置遵从协议的代理属性:

@property(nonatomic,weak,nullable)id<EMTransactionRecordBizDelegate>delegate;

协议方法的命名:

biz + 去掉EM和Biz的类名 + response(or other) + 返回的信息的描述

三.注释

1.所有的注释都需要写上  注释者和时间

2.Controller 头文件中 需要写上注释:说明这个类是做什么的,需要注意什么, 可以粘贴需求。

eg:

属性的注释规范/**<<#注释的内容#> */

@property(nonatomic,strong) EMTransactionRecordBiz *bizTransactionRecord;

eg:

4.public method 的注释   Common + alt + /

注释者+时间 + 这个方法是作什么的 + 参数的定义 + 返回的参数的定义

eg:

5.私有方法的注释

一般是#pragma mark ------ zs20170716XXX 方便内部的查找

如果需要可以参考4加上详细的参数注释

注意顺序:#pragma mark ——— zs20170716XXX 在上 详细注释在下

6.方法内部的注释

注释尽量写在这一行的后面 而不是这个行的上面 如果注释字数多可酌情处理 尽量用单行注释

eg:需要写上 注释者+时间

7.Model中的Entity的注释

服务器端返回的数据 往往需要我们生成对应的实体类

实体类的有些字段往往是允余的或者是现在没有用到的,这些字段也需要注释方便以后开发(此处优先级自行安排);

eg:

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

推荐阅读更多精彩内容