IOS基本代码规范(附带基本目录结构)

一、基本目录结构:

1、FCKit:主要包含(FCBaseCell、动画Kit、Category等)
2、FCBase:主要包含(FCBaseModel、BaseVC、Tool等)
3、FCNetWork:主要包含(FCBaseRequest、等)
4、ThirdParts:(第三方的源码)-- tip: 源码少的,需要自定义的可以用这种方式添加,否则用Pod方式。
5、APPDelegate:(APPDelegate和相关类目)
6、具体模块的文件夹:(Home、PersonCenter、More等)

二、基本编码规范:(好的命名是基础,不能因此而省略注释~)

1、新建UIViewController、UITableViewCell、Model都要继承父类,便于引入头文件、公用通用的方法。命名例子:HomeVC、HomeCell、HomeModel
2、方法、属性、宏的(命名、空格、换行、注释)例子:

方法的例子:(注释快捷键是:command+option+/),"+"后面有个空格,后面的”{“ 前面有个空格并且不要换行

/**
 *  判断字符串是否含表情
 *
 *  @param string 原有字符串
 *
 *  @return 返回是否有标题
 */
+ (BOOL)stringContainsEmoji:(NSString *)string {

}

属性的例子:(特别需要提示的注释可以用"///"在上面,否则可以直接写后面,尽量保持注释对齐)

/// 用户id
@property (nonatomic, strong) NSString      *userId;
@property (nonatomic, strong) NSString      *urlString;         // 网络的url
@property (nonatomic, strong) NSString      *loadHTMLURL;       // 本地的url

宏的例子:(按类型分类:UtilMacro.h、SizeMacro.h、NotificationMacro.h、ThirdMacro.h等)

1、尺寸相关的宏一般用全大写,下划线分割
/// 主屏的宽
#define SCREEN_WIDTH [[UIScreen mainScreen] bounds].size.width
2、UtilMacro.h相关的一般是”k“开头,下划线分割,可读性强
#define kAnimation_Time 0.3f
2、ThridMacro.h相关的一般是”k“开头,可读性强
#define kUmengKey               @"aaaaaaaaa" // 友盟key
#define kBuglyId                @"aaaaaddd"  // Bugly的id

循环、判断的例子:(注意空格和换行)

  // 判断语句,注意空格、换行   
    if (self) { 
    
    } else {
    
    }
    // 循环语句,注意空格、换行
    for (NSString *itemStr in array) {
    
    }

Tip: 上面是最常用的规范,也是最简单的规范,发现好多开发者对最基本的规范都不遵守。导致代码很乱,看着很不爽。(感觉上面的规范只要遵守好,不至于代码很乱)

以后有机会了,可能会增加些更多的代码规范。(有时候过于复杂的代码规范,可能会起到反作用)过犹不及~

长期维护的iOS开源项目:
https://github.com/zjjzmw1/XM_OC_TOOL

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