美文网首页iOS开发
写给自己的代码规范

写给自己的代码规范

作者: moonCoder | 来源:发表于2017-03-12 00:41 被阅读286次

    1、语言

    应该使用US英语。

    应该:

    UIColor *baseColor = [UIColor whiteColor];

    2、代码组织

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

    星号表示变量是指针。例如:

    NSString *text

    既不是 NSString* text

    也不是 NSString * text,除了一些特殊情况下常量。

    私有变量应该尽可能代替实例变量的使用。尽管使用实例变量是一种有效的方式,但更偏向于使用属性来保持代码一致性。

    通过使用’back’属性(_variable,变量名前面有下划线)直接访问实例变量应该尽量避免,除了在初始化方法(init, initWithCoder:, 等…),dealloc 方法和自定义的setters和getters。

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

    应该:

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

    @property (strong, nonatomic) NSString *tutorialName;

    3、在函数分组和protocol/delegate实现中使用#pragma mark -来分类方法。

    4、每一行的最大长度,在Xcode > Preferences > Text Editing > Page guide at column中将最大行长设置为80,过长的一行代码将会导致可读性问题。

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

    6、方法大括号和其他大括号(if/else/switch/while 等.)总是在同一行语句打开但在新行中关闭。

    7、在方法之间应该有且只有一行,这样有利于在视觉上更清晰和更易于组织。在方法内的空白应该分离功能,但通常都抽离出来成为一个新方法。

    8、如果一个函数有特别多的参数或者名称很长,应该分行,以冒号进行对齐。

    9、在书写协议的时候注意用<>括起来的协议和类型名之间是没有空格的,比如DemoClass(),这个规则适用所有书写协议的地方,包括函数声明、类生命、实例变量等等。

    10、应该使用可读性更好的语法来构造NSArray、NSDictionary等数据结构,避免冗长的alloc、init方法。

    如果构造代码写在一行,需要在括号两端留一个空格,使得被构造的元素与构造语法区分开来:

    NSArray array = @[ [foo description], [bar description] ];

    NSDictionary dict = @{ NSForegroundColorAttributeName:[NSColor redColor] };

    NSNumber *shouldUseLiterals = @YES;

    NSNumber *buildingStreetNumber = @10018;

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

    应该:

    NSInteger arrayCount = [self.array count];

    view.backgroundColor = [UIColor orangeColor];

    [UIApplication sharedApplication].delegate;

    不应该:

    NSInteger arrayCount = self.array.count;

    [view setBackgroundColor:[UIColor orangeColor]];

    UIApplication.sharedApplication.delegate;

    13、当需要注释时,注释应该用来解释这段特殊代码为什么要这样做。任何被使用的注释都必须保持最新或被删除。

    一般都避免使用块注释,因为代码尽可能做到自解释,只有当断断续续或几行代码时才需要注释。

    14、Apple命名规则尽可能坚持,特别是与这些相关的memory management rules (NARC)。

    长的,描述性的方法和变量命名是好的。

    应该:

    UIButton *settingsButton;

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

    static NSTimeInterval const RWTTutorialViewControllerNavigationFadeAnimationDuration = 0.3;

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

    应该:

    @property (strong, nonatomic) NSString *descriptiveVariableName;

    15、当使用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,

    };

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

    16、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;

    17、条件语句主体为了防止出错应该使用大括号包围,即使条件语句主体能够不用大括号编写(如,只用一行代码)。这些错误包括添加第二行代码和期望它成为if语句;还有,even more dangerous defect可能发生在if语句里面一行代码被注释了,然后下一行代码不知不觉地成为if语句的一部分。除此之外,这种风格与其他条件语句的风格保持一致,所以更加容易阅读。

    应该:

    if  (!error)  {

    return success;

    }

    18、当访问CGRect里的x, y, width, 或 height时,应该使用CGGeometry函数而不是直接通过结构体来访问。引用Apple的CGGeometry:

    在这个参考文档中所有的函数,接受CGRect结构体作为输入,在计算它们结果时隐式地标准化这些rectangles。因此,你的应用程序应该避免直接访问和修改保存在CGRect数据结构中的数据。相反,使用这些函数来操纵rectangles和获取它们的特性。

    应该:

    CGRect frame = self.view.frame;

    CGFloat x = CGRectGetMinX(frame);

    CGFloat y = CGRectGetMinY(frame);

    CGFloat width = CGRectGetWidth(frame);

    CGFloat height = CGRectGetHeight(frame);

    CGRect frame = CGRectMake(0.0, 0.0, width, height);

    不应该:

    CGRect frame = self.view.frame;

    CGFloat x = frame.origin.x;

    CGFloat y = frame.origin.y;

    CGFloat width = frame.size.width;

    CGFloat height = frame.size.height;

    CGRect frame = (CGRect){ .origin = CGPointZero, .size = frame.size };

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

    - (instancetype)sharedInstance {

       static id sharedInstance = nil;

      static dispatch_once_t onceToken;

      dispatch_once(&onceToken,{

      sharedInstance = [[self alloc] init];

      });

    return sharedInstance;

    }

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

    例如:

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

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

    21、项目尽量不要有硬编码

    22、类名以大写字母开头,应该包含一个名词来表示它代表的对象类型,同时可以加上必要的前缀,比如NSString, NSDate, NSScanner, NSApplication等等。

    23、一个委托方法的第一个参数是触发它的对象,第一个关键词是触发对象的类名,除非委托方法只有一个名为sender的参数:

    根据委托方法触发的时机和目的,使用should,will,did等关键词

    - (BOOL)tableView:(NSTableView *)tableView shouldSelectRow:(int)row;

    24、重中之重:整个工程中风格要统一

    相关文章

      网友评论

        本文标题:写给自己的代码规范

        本文链接:https://www.haomeiwen.com/subject/znnzgttx.html