iOS 代码规范

简单写了几点,参照了唐巧的类结构和Getter初始化方式。

iOS 代码规范

主题

    - 注释规范

    - 类结构

    - 属性初始化

    - 图片命名规则

    - 工程目录结构

    - 宏定义

    - Delegate 定义

    - HTTP 接口定义

1,注释规范

    1.1 单行注释

        /// 简要描述.

    1.2 多行注释

        /** 简要描述.

        *

        * 详细描述或其他.

        */

2,类结构

    使用#pragma mark –来分类方法

        #pragma mark – Life Cycle

        #pragma mark - Events

        #pragma mark – Private Methods

        #pragma mark - UITextFieldDelegate

        #pragma mark - UITableViewDataSource

        #pragma mark - UITableViewDelegate

        #pragma mark - Custom Delegates

        #pragma mark – Getters and Setters

3,属性初始化

    建议直接使用Getter初始化,但不建议在Getter里涉及太多逻辑。

    如果ViewController有多个View部分初始化,建议单独写个用作初始化的方法,例如 _initView OR _initSubview,数据初始化可以单独写作_initData 方便阅读。

4,图片命名规则

    4.1 建议使用Image Assets管理图片;

         Image Assets能很好区别二倍图和三倍图,并且能更直观的看到图片内容。

    4.2 图片文件命名;

        · 用英文命名,不用拼音

        · 每一部分用下划线分隔

        · 图片名中两倍图在名字最后要加@2x,三倍图在名字最后要加@3x

        规则: 模块 + 类别 + 功能 + 状态

        例如: tab + button + search + normal =  tab_button_seach_normal@2x.png

    4.3 图片文件夹分类尽量按功能模块分类;

5,工程目录结构

    工程目录结构分为:基础部分+功能模块部分;

     例如:Supporting Files + Resource + Vendor + UI Components + Category + Extendtion + 功能模块(Profile + Login 等等)。

6, 宏定义

    一般涉及宏定义的部分为工具部分(例如NSLog和获取UIApplication单例),另一部分是涉及http 接口部分,建议区分为不同的宏定义文件,以便于统一管理。

7,Delegate 定义

    Delegate的命名一定要写清楚Delegate所属,例如UITableview + Delegate;

    Delegate的方法定义时建议遵守Apple的规范,例如:-(CGFloat)tableView:(UITableView *)tableView heightForRowAtIndexPath:(NSIndexPath *)indexPath;

    规则是:传递委托对象 + 传递参数

8,HTTP 接口定义

    建议直接建一个HttpInterfaceManager类,统一定义针对某一个Server的接口调用,可以用类结构(见同主题2)区分不同模块,如果工程涉及Http接口太多可以考虑按模块分类。

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

推荐阅读更多精彩内容

  • iOS编程规范0规范 0.1前言 为􏰀高产品代码质量,指导广大软件开发人员编写出简洁、可维护、可靠、可 测试、高效...
    iOS行者阅读 4,456评论 21 35
  • 一、命名规范 1、统一要求含义清楚,尽量做到不需要注释也能了解其作用,若做不到,就加注释,使用全称,不使用缩写。 ...
    Untils阅读 564评论 0 0
  • 前言 最近突发奇想,想到之前公司培训的代码规范,所以简单的整理一下,希望能对大家有所帮助。 正文 部分一 1. 命...
    SwordDevil阅读 563评论 0 1
  • Version:1.0.0 Objective-C工程及代码规范 一、工程总述 1.工程名称为英文 工程名称必须为...
    小霍同学阅读 469评论 2 4
  • Hello 大家好,我还活着。 放假了,最近的日子过的特别的闲适安逸。 每天都是在书吧或者奶茶店点杯茶,一本书坐上...
    易暖非文阅读 223评论 0 0