IOS开发编码与命名规范.doc

IOS开发编码及命名规范 目录 TOC \o 1-3 \h \z \u HYPERLINK \l _Toc319595595 1、目的 PAGEREF _Toc319595595 \h 3 HYPERLINK \l _Toc319595596 2、适用范围 PAGEREF _Toc319595596 \h 3 HYPERLINK \l _Toc319595597 3、编码规范 PAGEREF _Toc319595597 \h 3 HYPERLINK \l _Toc319595598 3.1、文件 PAGEREF _Toc319595598 \h 3 HYPERLINK \l _Toc319595599 3.2、注释 PAGEREF _Toc319595599 \h 3 HYPERLINK \l _Toc319595600 3.3、编码排版格式 PAGEREF _Toc319595600 \h 4 HYPERLINK \l _Toc319595601 3.4、命名规范 PAGEREF _Toc319595601 \h 6 HYPERLINK \l _Toc319595602 3.4.1、保留字 PAGEREF _Toc319595602 \h 6 HYPERLINK \l _Toc319595603 3.4.2、方法 PAGEREF _Toc319595603 \h 7 HYPERLINK \l _Toc319595604 3.4.3、变量 PAGEREF _Toc319595604 \h 7 HYPERLINK \l _Toc319595605 3.4.4、常量 PAGEREF _Toc319595605 \h 8 HYPERLINK \l _Toc319595606 3.4.5、类 PAGEREF _Toc319595606 \h 8 HYPERLINK \l _Toc319595607 3.5、修改规范 PAGEREF _Toc319595607 \h 9 HYPERLINK \l _Toc319595608 3.5.1、新增代码行 PAGEREF _Toc319595608 \h 9 HYPERLINK \l _Toc319595609 3.5.2、删除代码行 PAGEREF _Toc319595609 \h 9 HYPERLINK \l _Toc319595610 3.5.3、修改代码行 PAGEREF _Toc319595610 \h 9 1、目的 统一规范XCode编辑环境下Objective-C的编码风格和标准 2、适用范围 适用于所有用Objective-C语言开发的项目。 3、编码规范 3.1、文件 1) 项目文件必须使用一个有意义的名字且前缀以PRJ_。例如：XCcode中下拉刷新的项目文件被命名为’PRJ_ PullDownRefresh.xcodeproj’。 2) 公共文件统一命名为’Public.h’。任何文件的命名尽量不要以中文命名。 3) 对于文件的目录要按如下结构创建： -Document（文档所在路径） -Help（帮助文件所在路径） -图片等资源文件放在单独的目录与组(Group)中，如Images。 -所有的view放在单独的组(Group)中，如Custom View。 -所有的viewController放在单独的组中，如viewControllers。 -引用外部文件或者某个单独的功能时，放在单独的组中， 例如： 程序中使用了coverflow功能，引用openflow的文件时，将其全部文件放在openFlow这个组中。其view和viewcontroller等文件的组织不受上面所规定的影响。 3.2、注释 1) 注释可以采用’ /* */ ’和’ // ’两种注释符号，涉及到多行注释时，尽量使用 ’ /* */ ’。 2) 对于一行代码的注释可放在前一行及本行上，不允许放在下一行，更不允许在一行语句的中间加入注释。 3) 单元文件的文件头注释说明应按如下格式： // // 文件名 // 工程名 // // Created by 创建者 on 日期. // Copyright 2010 xxx有限公司. All rights reserved. // // 系统名称： // 功能描述： // 修改记录：(仅记录功能修改) // 张三 2012-02-02 创建该单元 // 小明 2010-03-02 增加本地点单功能。 // 4) 方法前面的注释遵循以下格式：如果某项没有，则以N/A表示 例如： /*********