iOS编码规范汇总

CodeReview 代码评审

1.全部MVVM模式

api和数据处理全部放在VM里面处理,M里面不要有业务代码

2.能使用 @class 在.h ,不要 #import

@class XMPerson.h

3.注释规范

1.类.h要有说明其用途  
2.属性生命需要用///注释 
/// 声音标题
@property (nonatomic ,copy) NSString *voiceTitle;
3. 内容分段用 #param mark -  段内用 #param mark 
#pragma mark - 
#pragma mark - lazy
4.方法注释需要见名思意
// 设置无网络视图
- (void)resetNoNetView

4.命名规范(包括方法命名、类名、变量名)

1.统一驼峰命名,都以模块前缀开头
2.变量命名不要单个字符
3.类名末尾要包含此类的类型,比如XMRootView,XMRootViewController
4.命名原则要表达出其主要意图

5.属性

1.属性名称首字母小写,后续首字母大写;
2.使用@property,要保持必要的空格,如:@property (nonatomic, strong);
3.如果在@implementation内声明全局变量,则使用下划线前缀,局部变量不需要使用下划线前缀;
4.禁止使用a、b、c这样的变量命名,要见词达意;
5.属性命名时,要将属性类型编写到属性名中,使读者看到变量名即可知道这是个什么类型的变量,比如:usersDict,usersArray等。

6.方法

1.-或者+后加一空格;
- (void)viewDidLoad {
}
2.方法名首字母小写,后续单词首字母大写;
- (void)viewDidLoad
3.参数名首字母小写,后续单词首字母大写;

4.参数类型如果带有*号,则参数类型和*号之间加一空格;

5.如果方法太长、参数过多,可以换行冒号对齐,方法调用也一样;

6.非重写系统方法时,不要使用is、set和get前缀;

7.可以使用 can,should,will等词来协助表达存取方法的意思,但不要使用do和does;

8.不可以省略关键词;

9.尽量让方法的命名读起来像一句完整的话,能够传达出方法的意思;

7.使用统一前缀

XMMineSignTaskViewController

8.代码分模块

1.代码分模块写,不要写到公共里面去。能从公共抽出来的东西不要放里面去

9.VC里.m文件结构

生命周期前面、、通知、tableview、public、private、懒加载最后

10.方法的封装

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