OC 代码规范

代码规范

好久没更新了，确实忙，前段时间正好听前辈提起这方面的事情，>醍醐灌顶，哈哈，不废话了，把之前为了重构外包的代码，为项目>组写的规范贴出来给大家分享
提醒：
1.因为是规范，所以没有为什么，可以自己Google下
2.一些自己的习惯请忽略。。。。。。。。。

目的：写出执行迅速、便于理解、便于维护、便于扩展、不易出错的代码。

1. 使用泛型（制定容器类的类型）

NSArray<NSString *> *strings = @[@"sun", @"yuan"];
NSDictionary<NSString *, NSNumber *> *mapping = @{@"a": @1, @"b": @2};

2. __kindof

- (void)viewDidLoad {
    [super viewDidLoad];
     UIButton *but1 = [self getSubView];//不需要强转
}

- (__kindof UIView *)getSubView {
    UIButton *button = [UIButton buttonWithType:UIButtonTypeCustom];
    return button;
}

3. 使用nonnull、nullable、null_resettable

nonnull 声明的属性不能为空(getter方法和setter方法都有)
@property (nullable, nonatomic, copy) NSString *userId;

//在NS_ASSUME_NONNULL_BEGIN和NS_ASSUME_NONNULL_END之间,定义的所有对象属性和方法
默认都是nonnull
NS_ASSUME_NONNULL_BEGIN
@interface ViewController : UIViewController
@property (nonatomic, weak) UILabel *label;
@property (nonatomic, weak) UIButton * __nullable button;
@property (null_resettable, nonatomic, strong) NSArray *friends;
@end
NS_ASSUME_NONNULL_END


//nullable 声明的属性可以为空
@property (nullable, nonatomic, copy) NSString *str;

//null_resettable setter可以赋空值，getter方法取值不能为空
@property(null_resettable, nonatomic,strong) UIView *view;

4. 多用类型常量(含有类型信息)，少用#define预处理指令

define

#define kAnimationDuration @"男"

类型常量

//只在本实现文件中使用，前面字母加k
static const NSTimeInterval kAnimationDuration = 0.5;

//全局使用
//.h文件
extern NSString *const QYBoySex;
//.m文件
NSString *const QYBoySex = @"男”;

5.分类定义常量

  • 例如定义颜色 和 NSUserDefaults 的 Key
#pragma mark - UserDefaults Keys
typedef NSString *QYUserDefaultsKey;

///name
FOUNDATION_EXPORT QYUserDefaultsKey const KQYUserName;
///password
FOUNDATION_EXPORT QYUserDefaultsKey const KQYUserPassword;

#pragma mark - QY Color Hex
typedef NSString *HJDColorHex;

///blue
FOUNDATION_EXPORT HJDColorHex const QYNavBlue;
FOUNDATION_EXPORT HJDColorHex const QYButtonBlue;

6. 在类的头文件中尽量少引用其他头文件，使用向前声明该类的方式

QYPerson：

#import <Foundation/Foundation.h>
//#import “QYBoy.h"
@class QYBoy;
@interface QYPerson : NSObject

@property (nonatomic, copy) NSString *name;
@property (nonatomic, strong) QYBoy *boy;

@end

#import "QYPerson.h"
#import "QYBoy.h"

@implementation QYPerson

@end

QYBoy：

#import <Foundation/Foundation.h>
//#import "QYPerson.h"
@class QYPerson;

@interface QYBoy : NSObject

@property (nonatomic, copy) NSString *name;

- (void)setBoyWithPerson:(QYPerson *)person;

@end

7. 多用字面量语法，少用与之等价的方法

NSArray

  • 非字面量语法

    NSArray <NSString *> *array = [NSArray arrayWithObjects:@"1", @"2",  @"3", nil];

    • 取某个下标的对象

      NSString *str2 = newArray[1];

  • 字面量语法

    NSArray <NSString *> *newArray = @[@"1", @"2", @"3"];

    • 取某个下标的对象

       NSString *str1 = [array objectAtIndex:1];

需要注意的是

NSString *obj1 = @"1";
NSString *obj2 = nil;
NSString *obj3 = @"3";
//字面量语法 array1只含有obj1
NSArray <NSString *> *array1 = [NSArray arrayWithObjects:obj1, obj2, obj2, nil];
//非字面量语法 crash
NSArray <NSString *> *newArray1 = @[obj1, obj2, obj3];

8. 用枚举表示状态、选项、状态码等

typedef NS_ENUM(NSInteger, QYBoyStatus) {
    QYBoyIsRuning,
    QYBoyIsSleeping,
    QYBoyIsEating
};

9. 命名方式

  • 当应用程序自身和其所应用的程序库都引入了同名的第三方库，则应用前缀避免冲突

    #import "ABCLibrary"
#import “QYLibrary"

  • 开头小写后面单词首字母大写

    //全局变量
static const CGFloat QYScreenSize = [UIScreen mainScreen].bounds.size.width;
//属性命名 开头小写后面单词首字母大写
@property (nullable, nonatomic, copy) NSString *boyName;
//方法命名 开头小写后面单词首字母大写
- (void)addFriendWithPerson:(QYPerson *)person

  • 从命名上可以知道方法的功能

    NSString *text = @"she is a boy”;
NSString *newText = [text stringByReplacingOccurrencesOfString:@"boy" withString:@"girl"];//代码读起来像平时语言，易懂

//错误的方法命名
  • (void)configCellWith:(QYBoyModel *)boyModel :(NSInteger)index;
    //正确的方法命名
  • (void)configCellWithBoyModel:(QYBoyModel *)boyModel andIndex:(NSInteger)index;

  • 为私有方法名加前缀

    - (void)p_setUpUI {
}

  • 布尔值类型属性命名

    //getter方法用isLogined，setter用logined
@property(nonatomic, readonly, getter=isLogined) BOOL logined;

10. 将类的实现代码分散到便于管理的数个分类之中

#import <Foundation/Foundation.h>

@class QYBoy;

@interface QYPerson : NSObject

@property (nonatomic, copy) NSString *name;
@property (nonatomic, copy) NSArray *friends;
@property (nonatomic, strong) QYBoy *boy;

- (void)addFriends:(QYPerson *)friend;
- (void)removeFriend:(QYPerson *)friend;
- (BOOL)isFriendWithPerson:(QYPerson *)person;

@end

@interface QYPerson (Work)

- (void)goToWork;
- (void)goOffWork;

@end

@interface QYPerson (Play)

- (void)playAgame;
- (void)PlayWithThePhone;

@end

11. 为常用的块类型创建typedef

  • 不定义别名：

    - (void)workWithPresonBlock:(void (^) (NSString *name))personBlock;

  • 定义别名：

//两个块签名相同，但最好还是定义多个typedef，重构代码或需要修改时对其他的typedef无影响。
typedef void(^PersonWorkBlock)(NSString *);
typedef void(^PersonPlayBlock)(NSString *);
- (void)workWithPresonWorkBlock:(PersonWorkBlock)personWorkBlock;
- (void)playWithPresonPlayBlock:(PersonPlayBlock)personPlayBlock;

12. 多用块枚举，少用for循环

  • 块枚举

    NSArray *arr1 = @[@"1",@"2",@"3"];
[arr1 enumerateObjectsUsingBlock:^(NSString * _Nonnull obj, NSUInteger idx, BOOL * _Nonnull stop) {
    //do something
}];
    
NSDictionary *dic1 = @{@"1":@"one",@"2":@"two",@"3":@"three"};
[dic1 enumerateKeysAndObjectsUsingBlock:^(id  _Nonnull key, id  _Nonnull obj, BOOL * _Nonnull stop) {
    //do something
}];

13. 注释

/**
 类注释
 */
@interface QYPerson : NSObject
/* 属性注释 */
@property (nonatomic, copy) NSString *name;

@property (nonatomic, strong) QYBoy *boy; //属性注释

/**
 添加朋友（方法注释）

 @param Friend 某一个朋友对象
 */
- (void)addFriends:(QYPerson *)friend;

@end
最后编辑于 ：
©著作权归作者所有,转载或内容合作请联系作者
  • 人面猴
    序言：七十年代末，一起剥皮案震惊了整个滨河市，随后出现的几起案子，更是在滨河造成了极大的恐慌，老刑警刘岩，带你破解...
    沈念sama阅读 158,736评论 4赞 362
  • 死咒
    序言：滨河连续发生了三起死亡事件，死亡现场离奇诡异，居然都是意外死亡，警方通过查阅死者的电脑和手机，发现死者居然都...
    沈念sama阅读 67,167评论 1赞 291
  • 救了他两次的神仙让他今天三更去死
    文/潘晓璐 我一进店门，熙熙楼的掌柜王于贵愁眉苦脸地迎上来，“玉大人，你说我怎么就摊上这事。” “怎么了？”我有些...
    开封第一讲书人阅读 108,442评论 0赞 243
  • 道士缉凶录：失踪的卖姜人
    文/不坏的土叔 我叫张陵，是天一观的道长。 经常有香客问我，道长，这世上最难降的妖魔是什么？ 我笑而不...
    开封第一讲书人阅读 43,902评论 0赞 204
  • 港岛之恋（遗憾婚礼）
    正文 为了忘掉前任，我火速办了婚礼，结果婚礼上，老公的妹妹穿的比我还像新娘。我一直安慰自己，他们只是感情好，可当我...
    茶点故事阅读 52,302评论 3赞 287
  • 恶毒庶女顶嫁案：这布局不是一般人想出来的
    文/花漫 我一把揭开白布。 她就那样静静地躺着，像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上，一...
    开封第一讲书人阅读 40,573评论 1赞 216
  • 城市分裂传说
    那天，我揣着相机与录音，去河边找鬼。 笑死，一个胖子当着我的面吹牛，可吹牛的内容都是我干的。 我是一名探鬼主播，决...
    沈念sama阅读 31,847评论 2赞 312
  • 双鸳鸯连环套：你想象不到人心有多黑
    文/苍兰香墨 我猛地睁开眼，长吁一口气：“原来是场噩梦啊……” “哼！你这毒妇竟也来了？” 一声冷哼从身侧响起，我...
    开封第一讲书人阅读 30,562评论 0赞 197
  • 万荣杀人案实录
    序言：老挝万荣一对情侣失踪，失踪者是张志新（化名）和其女友刘颖，没想到半个月后，有当地人在树林里发现了一具尸体，经...
    沈念sama阅读 34,260评论 1赞 241
  • 护林员之死
    正文 独居荒郊野岭守林人离奇死亡，尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 30,531评论 2赞 245
  • 白月光启示录
    正文 我和宋清朗相恋三年，在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 32,021评论 1赞 258
  • 活死人
    序言：一个原本活蹦乱跳的男人离奇死亡，死状恐怖，灵堂内的尸体忽然破棺而出，到底是诈尸还是另有隐情，我是刑警宁泽，带...
    沈念sama阅读 28,367评论 2赞 253
  • 日本核电站爆炸内幕
    正文 年R本政府宣布，位于F岛的核电站，受9级特大地震影响，放射性物质发生泄漏。R本人自食恶果不足惜，却给世界环境...
    茶点故事阅读 33,016评论 3赞 235
  • 男人毒药：我在死后第九天来索命
    文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹，春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 26,068评论 0赞 8
  • 一桩弑父案，背后竟有这般阴谋
    文/苍兰香墨 我抬头看了看天上的太阳。三九已至，却和暖如春，着一层夹袄步出监牢的瞬间，已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 26,827评论 0赞 194
  • 情欲美人皮
    我被黑心中介骗来泰国打工， 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留，地道东北人。 一个月前我还...
    沈念sama阅读 35,610评论 2赞 274
  • 代替公主和亲
    正文 我出身青楼，却偏偏与公主长得像，于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子，可洞房花烛夜当晚...
    茶点故事阅读 35,514评论 2赞 269

推荐阅读更多精彩内容

  • OC代码规范总结
    Objective-C Coding Guidelines In Chinese Objective-C编码规范，...
    爨乡的云阅读 463评论 0赞 0
  • OC代码规范总结
    转载自：『博爱』 Objective-C-Coding-Guidelines-In-Chinese 概要 Obje...
    王_尧阅读 1,150评论 0赞 2
  • Google OC 代码规范
    示例 下面是一个示例头文件，演示了@interface声明的正确注释和间隔 一个示例源文件，演示了一个接口的@ i...
    我是Damo阅读 1,949评论 2赞 5
  • OC代码规范
    OC代码规范 一、代码格式 1.1、使用空格而不是制表符Tab 不要在工程里使用 Tab 键，使用空格来进行缩进。...
    whocare_阅读 1,951评论 0赞 3
  • OC代码规范
    命名 Preferred ： Not Preferred ： 代码组织 使用#pragma mark - 将生命...
    iOS收藏家阅读 883评论 0赞 0