Objective-C编码格式

代码组织

在函数分组和protocol/delegate实现中使用#pragma mark -来分类方法,要遵循以下一般结构:

#pragma mark - Lifecycle 
- (instancetype)init {} 
- (void)dealloc {} 
- (void)viewDidLoad {} 
- (void)viewWillAppear:(BOOL)animated {} 
- (void)didReceiveMemoryWarning {} 

#pragma mark - Custom Accessors 
- (void)setCustomProperty:(id)value {} 
- (id)customProperty {} 
#pragma mark - IBActions 
- (IBAction)submitData:(id)sender {} 
#pragma mark - Public 
- (void)publicMethod {} 
#pragma mark - Private 
- (void)privateMethod {} 
#pragma mark - Protocol conformance 
#pragma mark - UITextFieldDelegate 
#pragma mark - UITableViewDataSource 
#pragma mark - UITableViewDelegate 
#pragma mark - NSCopying 
- (id)copyWithZone:(NSZone *)zone {} 
#pragma mark - NSObject 
- (NSString *)description {} 

空格

  • 缩进使用4个空格,确保在Xcode偏好设置来设置。(raywenderlich.com使用2个空格)
  • 方法大括号和其他大括号(if/else/switch/while 等.)总是在同一行语句打开但在新行中关闭。
应该:
if (user.isHappy) { 
  //Do something 
} else { 
  //Do something else 
} 
不应该:
if (user.isHappy) 
{ 
//Do something 
} 
else { 
//Do something else 
} 
  • 应该避免以冒号对齐的方式来调用方法。因为有时方法签名可能有3个以上的冒号和冒号对齐会使代码更加易读。请不要这样做,尽管冒号对齐的方法包含代码块,因为Xcode的对齐方式令它难以辨认。

应该:

// blocks are easily readable
[UIView animateWithDuration:1.0 animations:^{ 
// something 
} completion:^(BOOL finished) { 
 // something 
}]; 

命名

三个字符前缀应该经常用在类和常量命名,但在Core Data的实体名中应被忽略。对于官方的raywenderlich.com书、初学者工具包或教程,前缀RWT
应该被使用。

常量应该使用驼峰式命名规则,所有的单词首字母大写和加上与类名有关的前缀。

应该:

static NSTimeInterval const RWTTutorialViewControllerNavigationFadeAnimationDuration = 0.3; 

不应该:

static NSTimeInterval const fadetime = 1.7; 

属性也是使用驼峰式,但首单词的首字母小写。对属性使用auto-synthesis,而不是手动编写@synthesize语句,除非你有一个好的理由。
应该:

@property (strong, nonatomic) NSString *descriptiveVariableName; 

不应该:

id varnm;
下划线

当使用属性时,实例变量应该使用self.来访问和改变。这就意味着所有属性将会视觉效果不同,因为它们前面都有self.

但有一个特例:在初始化方法里,实例变量(例如,_variableName)应该直接被使用来避免getters/setters潜在的副作用。

局部变量不应该包含下划线。

方法

在方法签名中,应该在方法类型(-/+ 符号)之后有一个空格。在方法各个段之间应该也有一个空格(符合Apple的风格)。在参数之前应该包含一个具有描述性的关键字来描述参数。

“and”这个词的用法应该保留。它不应该用于多个参数来说明,就像initWithWidth:height
以下这个例子:
应该:

- (void)setExampleText:(NSString *)text image:(UIImage *)image; 
- (void)sendAction:(SEL)aSelector to:(id)anObject forAllCells:(BOOL)flag; 
- (id)viewWithTag:(NSInteger)tag; 
- (instancetype)initWithWidth:(CGFloat)width height:(CGFloat)height;

不应该:

- (void)setT:(NSString *)text i:(UIImage *)image; 
- (void)sendAction:(SEL)aSelector :(id)anObject :(BOOL)flag; 
- (id)taggedView:(NSInteger)tag; 
- (instancetype)initWithWidth:(CGFloat)width andHeight:(CGFloat)height; 
- (instancetype)initWith:(int)width and:(int)height; // Never do this. 
变量

变量尽量以描述性的方式来命名。单个字符的变量命名应该尽量避免,除了在for()循环。

属性特性
所有属性特性应该显式地列出来,有助于新手阅读代码。属性特性的顺序应该是storage、atomicity,与在Interface Builder连接UI元素时自动生成代码一致。

应该:

@property (weak, nonatomic) IBOutlet UIView *containerView; @property (strong, nonatomic) NSString *tutorialName; 

不应该:

@property (nonatomic, weak) IBOutlet UIView *containerView; @property (nonatomic) NSString *tutorialName; 

NSString应该使用copy而不是strong的属性特性。
为什么?即使你声明一个NSString的属性,有人可能传入一个NSMutableString的实例,然后在你没有注意的情况下修改它。
应该:
@property (copy, nonatomic) NSString *tutorialName;

不应该:
@property (strong, nonatomic) NSString *tutorialName;

点符号语法

点语法应该总是被用来访问和修改属性,因为它使代码更加简洁。[]
符号更偏向于用在其他例子。

应该:

objc NSInteger arrayCount = [self.array count]; 
view.backgroundColor = [UIColor orangeColor]; 
[UIApplication sharedApplication].delegate; 

不应该:

NSInteger arrayCount = self.array.count;
 [view setBackgroundColor:[UIColor orangeColor]]; UIApplication.sharedApplication.delegate; 

字面值
NSString、NSDictionary、NSArray和NSNumber的字面值应该在创建这些类的不可变实例时被使用。请特别注意nil值不能传入NSArray和NSDictionary字面值,因为这样会导致crash。

应该:

NSArray *names = @[@"Brian", @"Matt", @"Chris", @"Alex", @"Steve", @"Paul"]; 
NSDictionary *productManagers = @{@"iPhone": @"Kate", @"iPad": @"Kamal", @"Mobile Web": @"Bill"}; 
NSNumber *shouldUseLiterals = @YES; 
NSNumber *buildingStreetNumber = @10018; 

不应该:

NSArray *names = [NSArray arrayWithObjects:@"Brian", @"Matt", @"Chris", @"Alex", @"Steve", @"Paul", nil]; 
NSDictionary *productManagers = [NSDictionary dictionaryWithObjectsAndKeys: @"Kate", @"iPhone", @"Kamal", @"iPad", @"Bill", @"Mobile Web", nil]; 
NSNumber *shouldUseLiterals = [NSNumber numberWithBool:YES]; NSNumber *buildingStreetNumber = [NSNumber numberWithInteger:10018]; 

常量
常量是容易重复被使用和无需通过查找和代替就能快速修改值。常量应该使用static 来声明而不是使用#define,除非显式地使用宏。

应该:

static NSString * const RWTAboutViewControllerCompanyName = @"RayWenderlich.com"; 
static CGFloat const RWTImageThumbnailHeight = 50.0; 

不应该:

#define CompanyName @"RayWenderlich.com" 
#define thumbnailHeight 2 

枚举类型
当使用enum时,推荐使用新的固定基本类型规格,因为它有更强的类型检查和代码补全。现在SDK有一个宏NS_ENUM()来帮助和鼓励你使用固定的基本类型。

例如:
typedef NS_ENUM(NSInteger, RWTLeftMenuTopItemType) { RWTLeftMenuTopItemMain,
RWTLeftMenuTopItemShows,
RWTLeftMenuTopItemSchedule
};

你也可以显式地赋值(展示旧的k-style
常量定义):

typedef NS_ENUM(NSInteger, RWTGlobalConstants) { 
RWTPinSizeMin = 1, 
RWTPinSizeMax = 5, 
RWTPinCountMin = 100, 
RWTPinCountMax = 500, 
}; 

旧的k-style
常量定义应该避免除非编写Core Foundation C的代码。
不应该:

enum GlobalConstants { 
kMaxPinSize = 5, 
kMaxPinCount = 500, 
}; 

Case语句

大括号在case语句中并不是必须的,除非编译器强制要求。当一个case语句包含多行代码时,大括号应该加上。

switch (condition) { 
        case 1: 
          // ...  
          break; 
        case 2: { 
        // ...  
        // Multi-line example using braces  
        break; 
      } 
        case 3: 
          // ...  
          break; 
        default: 
        // ...  
        break; 
} 

有很多次,当相同代码被多个cases使用时,一个fall-through
应该被使用。一个fall-through就是在case最后移除’break
’语句,这样就能够允许执行流程跳转到下一个case值。为了代码更加清晰,一个fall-through需要注释一下。

switch (condition) { 
    case 1: 
      // ** fall-through! **  
    case 2: 
      // code executed for values 1 and 2  
    break; 
    default: 
      // ...  
    break; 
} 

当在switch使用枚举类型时,’default’是不需要的。例如:

RWTLeftMenuTopItemType menuType = RWTLeftMenuTopItemMain; switch (menuType) { 
    case RWTLeftMenuTopItemMain: 
        // ...  
    break; 
    case RWTLeftMenuTopItemShows: 
        // ...  
    break; 
    case RWTLeftMenuTopItemSchedule: 
        // ...  
    break; 
} 

私有属性私有属性应该在类的实现文件中的类扩展(匿名分类)中声明,命名分类(比如RWTPrivate或private)应该从不使用除非是扩展其他类。匿名分类应该通过使用+Private.h文件的命名规则暴露给测试。
例如:

@interface RWTDetailViewController () 
@property (strong, nonatomic) GADBannerView *googleAdView; @property (strong, nonatomic) ADBannerView *iAdView; 
@property (strong, nonatomic) UIWebView *adXWebView; 
@end 
布尔值

Objective-C使用YES和NO。因为true和false应该只在CoreFoundation,C或C++代码使用。既然nil解析成NO,所以没有必要在条件语句比较。不要拿某样东西直接与YES比较,因为YES被定义为1和一个BOOL能被设置为8位。
这是为了在不同文件保持一致性和在视觉上更加简洁而考虑。
应该:

if (someObject) {} 
if (![anotherObject boolValue]) {} 

不应该:

if (someObject == nil) {} 
if ([anotherObject boolValue] == NO) {} 
if (isAwesome == YES) {} // Never do this. 
if (isAwesome == true) {} // Never do this. 

如果BOOL属性的名字是一个形容词,属性就能忽略”is
”前缀,但要指定get访问器的惯用名称。例如:

@property (assign, getter=isEditable) BOOL editable; 

文字和例子从这里引用Cocoa Naming Guidelines。

单例模式
单例对象应该使用线程安全模式来创建共享实例。

+ (instancetype)sharedInstance { 
    static id sharedInstance = nil; 
    static dispatch_once_t onceToken; 
    dispatch_once(&onceToken, ^{ 
        sharedInstance = [[self alloc] init]; }); 
    return sharedInstance; 
} 

这会防止possible and sometimes prolific crashes。

换行符
换行符是一个很重要的主题,因为它的风格指南主要为了打印和网上的可读性。
例如:

self.productsRequest = [[SKProductsRequest alloc] initWithProductIdentifiers:productIdentifiers]; 

一行很长的代码应该分成两行代码,下一行用两个空格隔开

self.productsRequest = [[SKProductsRequest alloc] initWithProductIdentifiers:productIdentifiers]; 

http://www.imooc.com/article/1216

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

推荐阅读更多精彩内容