目的

本文档编写是为了统一iOS开发的规范标准，使公司的编程工作更加规范化。
包括以下部分：

Xcode编辑环境下Objective-C的编码风格和标准；
Xcode项目新建的操作规范；
项目所有文件的命名规则；
项目的发布规范；

编码规范

1. 项目文件

项目命名规则

必须统一使用代表项目意义的名字。例如：Xcode中的项目文件统一命名。
可在target中 Class Prefix 统一配置类前缀。

公共文件

统一命名为 xx_Constant.h，CommonConfig.h，Macros.h。

任何文件/文件夹的命名不能以中文命名。

对于文件的目录要按如下结构创建（放在Project路径下的ProjectName文件夹下）：

⚠️ 所有文件夹必须是 实体文件夹

Global（全局文件，例如：xx_Constant.h，CommonConfig.h，Macros.h）

ThirdLibs (第三方类库统一目录)

Widget (自定义 UI组件)

Utils（自定义Utils，Helper，类别工具）

Resource （资源文件夹），其它资源文件放在单独的目录Resource中，并做细分。

图片资源全部放到 Assets.xcassets，另外为了方便图片资源文件管理，可以使用PDF矢量图片。

Class（模块文件），每个模块建立独立的文件夹进行管理。

Models (数据模型)

Views（视图文件）

Controllers（控制器）。

项目创建

项目的创建由项目经理统一一人按以上规范创建，创建完成后添加必要的第三方库类及开始页面、NavigationViewController和TabarViewController。然后由其导入SVN/Git版本控制库。项目其他参与人只能从版本库导出项目再进行开发。

项目的保存及修改

每天上班时间从版本库Checkout最新版本的进行开发工作，下班前把开发的工作版本先Update再commit保存到版本库中。

2. 注释

注释可以采用 /* */ 和 // 两种注释符号，涉及到多行注释时，尽量使用 /* */。
对于一行代码的注释可放在前一行及本行上，不允许放在下一行，更不允许在一行语句的中间加入注释。
类名、方法注释采用Xcode系统自带方式进行注释：option + command + /。特别是对外暴露的接口，要详细。

/**
 * Set the imageView `image` with an `url` and a placeholder.
 *
 * The download is asynchronous and cached.
 *
 * @param url         The url for the image.
 * @param placeholder The image to be set initially, until the image request finishes.
 * @see sd_setImageWithURL:placeholderImage:options:
 */
- (void)sd_setImageWithURL:(NSURL *)url placeholderImage:(UIImage *)placeholder;

必要的属性注释采用 //!<。
显而易见的代码不加注释。

3. 编码排版格式

代码的缩进应使用空格（SPACE），不能使用制表符（TAB），并且缩进以2个字符为单位。
中括弧的每一个括弧在源程序中要单独占一行。

例如 ** 争论很大 **

// 不正确用法

for (int i = 0; i < 10 ; i++) {
    // code
}

// 正确用法

for (int i = 0; i < 10; i++)
{
    // code
}

每行代码最多不得操作100个字。设置如下：Xcode => Preferences => TextEditing => Page Guide at column /输入 100即可。

空格的使用

关键字与其后的表达式之间要有空格，如：
if(expr) //错误的写法
if (expr) //正确的写法

for(expr) //错误的写法
for (expr) //正确的写法
单目操作符不应与它们的操作数分开（如 ! 和 ^ 等）。

除 , 外，其它双目操作符应与它们的操作数用空格隔开。
例如

i=i+1;        //错误的写法，操作符两端没有空格

i = i + 1;    //正确的写法，

if(a>b)       //错误的写法，逻辑判断符号两端没有空格

if (a > b)    //正确的写法
协议<>前面有一个空格。
@interface ViewController : UIViewController <UITableViewDelegate, UITableViewDataSource>
.h中成员声明时，类型与变量之间有至少1个空格。*号靠近变量，不靠近类型。

@property后留1个空格，（）里面，逗号紧跟前一变量，与后一变量之间留1个空格。（）外面，先留1个空格，再声明属性。
@property (strong, nonatomic) UIWindow *window;
方法的+，-后面与（）之间留1个空格。
+(instancetype)databaseWithPath:(NSString*)inPath; //错误的写法
+ (instancetype)databaseWithPath:(NSString*)inPath; //正确的写法

-(void)viewDidLoad //错误的写法 
- (void)viewDidLoad //正确的写法
返回类型与 * 之间留1个空格，方法参数中返回类型与 * 之间留1个空格。
- (void)sd_setImageWithURL:(NSURL *)url placeholderImage:(UIImage *)placeholder;
在多参数方法中，每个参数后面都有1个空格。

每行只能有一个语句。
例如

//不正确写法

NSUInteger objectIndex, stuffCount;

或

objectIndex = objectIndex + 10, stuffCount = stuffCount + 20;

或

@synthesize MyView, MyLabelView;


//正确写法

NSUInteger  objectIndex;

NSUInteger  stuffCount;

或

objectIndex = objectIndex + 10;

stuffCount = stuffCount + 20;

或

@synthesize MyView;

@synthesize MyLabelView;

关于空行

.h中的空行

文件说明与头文件包含(#import)之间空1行

头文件包含(#import)之间，如果需要分类区别，各类别之间空1行。

头文件包含(#import)与@class之间空2行。

@interface与@class之间空1行。

头文件{}里面，空1行开始声明对象成员，如果需要分类区别，各类别之间空1行。

头文件{}外，空1行书写属性，如果需要分类区别，各类别之间空1行。

属性下面空1行开始写方法，如果需要分类区别，各类别之间空1行。

方法完成后，空1行@end。

如果需要声明protocol，空2行接着写。通常protocol写在@end后面，但是声明在@interface之前。

.m 中的空行

文件说明与头文件包含(#import)之间空1行。

头文件包含(#import)之间，如果需要分类区别，各类别之间空1行。

方法与方法之间空1行。

方法里面的空行

变量声明后需要空1行，如果需要分类区别，各类别之间空1行。

条件、循环，选择语句，整个语句结束，需要空1行。

各功能快之间空1行。

最后一个括弧之前不空行。

注释与代码之间不空行。

pragma mark 与方法之间空1行。

命名规范

命名原则

各种类型的文件都必需以公司名开头大写，譬如TX（腾讯缩写） (前提是全部统一)，然后接其名字，其名字的单词均以第一个字母大写开头：其余字母全部为小写：例如某个类名：TXNewsDetail.h 图片名：TX_UserHead.png . 尽量采用有意义的英文单词命名，实在无办法才使用中文拼音。

类名

所有的类名，接口名(Protocol)均以大写字母开头（例如我们公司：TX），多单词组合时，后面的单词首字母大写。类，接口名必须是有意义的。
继承自UIView的类以View结尾。

例如：

TXUsersInfoView，TXLabelView等。

继承自ViewController的类以ViewController结尾。

例如：

TXHomePageViewController，TXLoginViewController等。其他类推。

所有保存数据的实体以TX开头Model结尾。

例如：

TXUserModel

方法名

方法的名称应全部使用有意义的单词组成，且以小写字母开头，多单词组合时，后面的单词首字母大写, 在 - + 和返回值之间留1个空格，方法名和第一个参数间不留空格。

例如：

- (void)getUserInformation

设置类变量的内容的方法应使用set作为前缀，读取变量的内容的方法应使用get作为前缀。如用属性则不用关心此问题。

例如：

- (void)getUserName;

- (void)setUserName:(NSString *)userName;

方法中的参数：第一个参数名称要从函数名称上携带出来，第二个参数的首字母小写，多个单词组合时，后面单词首字母大写。参数有别名时，参数别名与参数名一致，但参数名前缀以_。参数别名与前一参数保留1个空格。参数无别名时，以有意义的字母命名。

例如：

- (void)myFunctionWithSizeA:(CGSize)sizeA sizeB:(CGSize)sizeB;

变量名

变量必须起有意义的名字，使其他组员可以很容易读懂变量所代表的意义，变量命名可以采用同义的英文命名，可使用几个英文单词，第一个单词首字母小写，其他单词首字母大写。

例如：

NSString *userName;

对于一些特殊类型的变量，命名时要带上类型，如NSArray 的变量命名为xxxArray，其他的如xxxDictionary，xxxSize等。这样就可以从名称上知道是什么类型的变量。千万不能将NSArray的变量命名为xxxDictionary。
对于要和interface builder关联的的输出口变量，命名时要后缀以特定的控件名。

例如：

IBOutlet UILabel *userNameLabel;

对于使用c语言形式声明的变量，一些特定类型可采用一定的简写：

例如：

指针类型：P

数组类型：Arr

Core Graphic：CG

等。

循环控制变量通常使用单一的字符如：i、j、k等。使用有意义的名字，如objectIndex也是可以的。

尽量避免使用全局变量，如果必须使用全局变量则必须加前缀 Pub_，同时应在变量名称中体现变量的类型。
私有实例变量前加一个下划线，如：_myPrivateVarible。
枚举变量也要有相应的前缀来区分不同的enum变量。

例如：

/*
typedef NS_ENUM(_type, _name) new;

_type：枚举类型变量值的格式
_name：枚举类型的名字
new：枚举类型的变量值列表
*/

typedef NS_ENUM(NSUInteger, Seasons) {
    spring = 0,
    summer,
    autumn,
    winter
};

常量名

避免在程序中直接出现常数，使用超过两次以上的应以宏定义的形式来替代。

常数的宏定义应与它实际使用时的类型相一致。如以3.0来定义浮点类型，用3表示整型。

常量的命名应当能够表达出它的用途，并且用大写字母表示。
例如：

#define PI 3.1415926
一些常量前加特殊前缀，可以作为不同常量的区分，
例如：

UserDefaultsKey 前加 UDKEY_,

NotificationNameKey 前加 NNKEY_,

DictionaryKey 前加 DICTKEY_,

保留字
Objective-c语言的保留字或关键词应全部使用小写字母，除下表中保留字外，private、protected、public、在类型说明中也作为保留字使用。还有nonatomanic,retain,readwrite,readonly等也有特殊的使用场合。这些在我们公司全部不用。

用户界面规范

UI图片命名规则

NavgitonBar

导航条背景图：TX_NavBarBG.png
导航条左按钮：TX_NavBarRightBtn.png
导航条右按钮：TX_NavBarLeftBtn.png
导航条返回按钮：TX_NavBarBackBtn.png

TabBar

TabBar背景图：TX_TabBarBG.png
TabBar icon normal（默认状态）：TX_TabItem_NewsNL.png，TX_TabItem_xxx.png
TabBar icon hight light（高亮状态）：TX_TabItem_NewsHL.png，TX_TabItemHL_xxx.png
TabBar icon Selected（选中状态）：TX_TabItemSL.png

按钮
界面普通按钮必需按照实际使用有意义的动作而命名。命名规则根据总原则以TX开头，以实际动作定义(必须使用英文标示)，并Btn结尾以标识是一个按钮！

比如登陆按钮： TXLoginBtn.png

AppIcon 、LaunchImage 具体的需求看兼容版本
启动图片

Default-736h.png                1242 × 2208 pixels       Retina HD 5.5

Default-667h.png                750 × 1334 pixels         Retina HD 4.7

Default-568h@2x~iPhone.png      640 × 1136 pixels        Retina 4

Default@2x~iPhone.png                640 × 960 pixels           2x

Default-Portrait~iPad.png               768 x 1024 pixels         1x

Default-Portrait@2x~iPad.png             1536 x 2048 pixels       2x

iOS 开发编码及命名规范