iPhone编程规范

来源:互联网 发布:专题片男生配音软件 编辑:程序博客网 时间:2024/04/19 13:10

一、类

  1. 与XxYyyController对应的xib文件应该命名为XxYyy。

    xib文件的命名

  2. 类中功用相同的成员应以tab对齐。不同功用的成员变量(以及对应的property)、成员函数前后以空行隔开。
  3. 先写property,再写静态函数,再写成员函数
    1
    2
    3
    4
    5
    6
    7
    8
    9
    @property(nonatomic,retain)NSData   *channelListXMLData;
     
    + (ViewSwitcher *)getInstance;
    + (void)destoryInstance;
     
    - (void)showWelcomeView;
    - (void)showMenuView;
    - (void)showChannelView;
    - (void)showArticleView;

二、函数和语句

  1. 函数的-+标识符后应紧接一个空格,返回值的括号右侧紧跟函数名函数形参规则
  2. 函数的形参若与类成员变量冲突,如scrollView,则使用theScrollView或者aScrollView这样的形式
  3. 函数的大括号使用苹果xcode预定义的方式:前大括号不换行,前面加一个空格
  4. 函数创建的内存:谁创建,谁销毁。函数名中不含有new、alloc、create、copy的,返回值都应该是autorelease的对象。反之,创建的内存由调用者释放。函数返回值的内存管理
  5. 语句中:二元操作符(- + = == < >)左右都有空格,一元操作符仅左边(或者右边)有空格
    1
    2
    3
    i = i + 1;
    if(xTmp = ++i) { doSomeThing(); }
    if(i-- == xTmp) { whyDoYouDoThis(shit) }
  6. 太长且有视觉上的重复性的代码,使用有意义的折行:
    1
    2
    3
    4
    5
    6
    return[NSStringstringWithFormat:@"%02x%02x%02x%02x%02x%02x%02x%02x%02x%02x%02x%02x%02x%02x%02x%02x",
                result[0],  result[1],  result[2],  result[3],
                result[4],  result[5],  result[6],  result[7],
                result[8],  result[9],  result[10], result[11],
                result[12], result[13], result[14], result[15]
                ];

三、变量

  1. 统一使用UI库封装的基本类型,如NSInteger CGFloat,而不是int float

四、注释与编译器标识

  1. 注释使用xcode预定义的方式:/* 和 */都独立占用一行代码注释规则
  2. 功能相关的一类函数,使用#pragma mark -来分隔,功能相关的函数要分类,使用#pragma mark xxxxxxx来分隔

五、宏

  1. 宏的命名规则:所有字母大写,单词之间以下划线分隔
    1
    2
    #define FM_DEFAULT_IDENTITY        @"default_identity"
    #define FM_DEFAULT_ROOT_PATH       @"default_root_path"

    宏命名规范

  2. 宏名应该以所在类或文件的标示来开头