代码规范

驼峰命名法
OC提倡自注释命名方式,即通过多个单词组合成一个有含义的类名,变量名或者方法名.
为了方便区分单词,采用单词首字母大写的方式.

  • 类名所有单词首字母都要大写
  • 变量名第一个单词首字母小写
  • 方法名采用动宾结构,也就是'动词'+'名词'的形式;第一个单词首字母小写
    例如:
    用户信息类:
@interface UserInfo: NSObject{ 
//用户名变量 
NSString *_userName;
//用户学生编号
 int _userStudentCount;
} 
//创建用户名方法: 
 - (void)createUserName;
@end

空格的使用方式
声明变量时,指针符号*与变量名无间隔,与类名有一个空格间隔

形式上是 类名 *变量名
- NSString *user = @"";
- NSArray *userList = @"";

使用,, ;时, 与前方单词无间隔,后面加一个空格

形式上是'单词, '
- @interface UserInfo: NSObject{} @end
- @[@"11", @"22", @"33", @"44"];
- @{@"userName": @"美玲", @"sex": @"女", @"age": @22};
- NSLog(@"%@", userList);
- for(int i = 0; i < 9; i++){}

三目运算符

条件语句 ? 真值 : 假值;
NSString *category = age <= 18 ? @"小孩" : @"成年人";为变量做非空处理NSString *aStr = nil;aStr = aStr ?: @"";代码作用是判断aStr是否为nil如果是nil,那么赋值为@""; 否则什么都不做

运算符=, ==, +, -, *, /, %, +=, -=, *=, /=, %=前后加空格

* a += 4;
* int c = b + 2;
* NSString *name = @"美玲";
* if(i == 5){}

自增自减

i++; i--; --i; ++i; 变量和运算符之间无空格
for(int i = 0; i < 9; i++){}

方法的声明
对象方法或者类方法的+, -号后面加空格

- (void)createUser;
+ (id)userWithType;

单例方法
通常以'standard', 'default', 'main', 'shared', 'current'单词开头

+ (UIApplication *)sharedApplication
+ (UIScreen *)mainScreen; 
+ (UIDevice *)currentDevice;
+ (NSUserDefaults *)standardUserDefaults;
+ (NSFileManager *)defaultManager;

类工厂方法

通常以类名开头
+ (instancetype)buttonWithType:(UIButtonType)buttonType;
+ (instancetype)stringWithString:(NSString *)string;

关系词

'At', 'From', 'To', 'With', 'By'
- (unichar)characterAtIndex:(NSUInteger)index;
- (NSString *)substringFromIndex:(NSUInteger)from;
- (NSString *)substringToIndex:(NSUInteger)to;
- (NSString *)substringWithRange:(NSRange)range;
- (NSString *)stringByAppendingString:(NSString *)aString;

多参数方法, 除第一个参数,其他参数名通常不带有关系词

- (NSRange)rangeOfString:(NSString *)searchString options:(NSStringCompareOptions)mask range:(NSRange)searchRange;

属性的声明

@property后面加空格
@property (nonatomic, readonly) UITableViewStyle style;

常量的定义

代码中尽量不要出现字符串或者数字, 因为后期维护时不方便.
习惯上通过把字符串, 数字声明为常量, 做到常量的统一管理.
常量定义的方式有以下两种:
#define 宏定义
static const 静态常量
不管声明哪种类型的常量,变量名都需要添加'k'开头,这样可以有效防止命名冲突问题
具体使用时:
声明对象类型的常量时, 习惯使用:
static NSString *const kCellIdentify = @"CellName";
声明基础类型常量时, 习惯使用:#define kDuration 30

代码分段#pragma mark -

在代码中通常使用'#pragma mark - '来对代码进行分段,方便后期维护.
例如@implementation ViewController
#pragma 懒加载
- (UITableView *)someTable{return nil;}
- (UIButton *)someBtn{return nil;}
#pragma mark - UITableViewDataSource 表格数据
- (NSInteger)tableView:(UITableView *)tableView numberOfRowsInSection:(NSInteger)section{return 0;}
- (UITableViewCell *)tableView:(UITableView *)tableView cellForRowAtIndexPath:(NSIndexPath *)indexPath{return nil;}
#pragma mark - UITableViewDelegate 表格代理
- (void)tableView:(UITableView *)tableView didSelectRowAtIndexPath:(NSIndexPath *)indexPath{}
#pragma mark - 生命周期
- (void)viewDidLoad { [super viewDidLoad]; // Do any additional setup after loading the view, typically from a nib.}
- (void)viewWillAppear:(BOOL)animated{ [super viewWillAppear:animated];}
- (void)viewWillDisappear:(BOOL)animated{ [super viewWillDisappear:animated];}
- (void)didReceiveMemoryWarning { [super didReceiveMemoryWarning]; // Dispose of any resources that can be recreated.}
@end

成员变量的声明

成员变量要使用'_'进行标示
@interface UserInfo: NSObject{ NSString *_userName; //成员变量添加下划线_}
@end

协议的使用
协议的声明要跟’#import’关键词之间隔一行以上,否则没有代码提示

#import <UIKit/UIKit.h>
@protocol ViewControllerDelegate <NSObject>
@end
@interface ViewController : UIViewController
@property (nonatomic, weak) id<UITableViewDelegate> delegate;@end

协议变量要使用weak修饰

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

构造方法的返回值选择instancetype

- (instancetype)init
- (instancetype)initWithCoder:(NSCoder *)aDecoder
+ (instancetype)string;
+ (instancetype)stringWithString:(NSString *)string;
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念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

推荐阅读更多精彩内容

  • iOS编程规范0规范 0.1前言 为􏰀高产品代码质量,指导广大软件开发人员编写出简洁、可维护、可靠、可 测试、高效...
    iOS行者阅读 4,435评论 21 35
  • 推荐文章:禅与 Objective-C 编程艺 前言 为􏰀高产品代码质量,指导广大软件开发人员编写出简洁、可维护、...
    WolfTin阅读 2,749评论 0 1
  • 代码规范基本上都是从苹果原生示例代码中总结出来的, 大家可以多查看苹果示例代码进行学习. 驼峰命名法OC提倡自注释...
    skylor阅读 270评论 0 0
  • 示例 下面是一个示例头文件,演示了@interface声明的正确注释和间隔 一个示例源文件,演示了一个接口的@ i...
    我是Damo阅读 1,977评论 2 5
  • 注: Copy 自 cocoachina 英文原文:Swift Style Guide 翻译作者:码农网 – 豆照...
    Mid_Chan阅读 697评论 0 0