1.目的
统一规范XCode编辑环境下Objective-C的编码风格和标准
2.使用范围
适用于所有用Objective-C语言开发的项目。
3.编码规范
3.1、注释
1)注释可以采用’ /* */ ’和’ // ’两种注释符号，涉及到多行注释时，尽量使用’ /* */ ’。
2)对于一行代码的注释可放在前一行及本行上，不允许放在下一行，更不允许在一行语句的
中间加入注释。
3)单元文件的文件头注释说明应按如下格式:
//文件名
//工程名//
// Created by创建者on期.
// Copyright 2010 . All rights reserved.//
//系统名称:
//功能描述:
//修改记录:(仅记录功能修改)
// 张三2012-02-02创建该单元
// 小明2010-03-02增加本地点单功能。
//
4)方法前 的注释遵循以下格式:如果某项没有，则以N/A表
例如:
/**********************************************************
函数名称:-(BOOL)showFiveAndSixStairRoomCountByStatu
函数描述:显示特定状态下五楼和六楼的房间数
输入参数:(NSString *)statu:某状态。
输出参数:(int *)roomCount:该状态房间数量。
返回值:BOOL:操作是否成功。
**********************************************************/
- (void)ShowFiveAndSixStairRoomCountByStatu:(NSString *)staturoomCount:(int*)_roomCount;
或
/**********************************************************
函数名称:-(NS UInteger)showF iveAndS ixS tairRoomCount
函数描述:显示五楼六楼的房间数。
输入参数:N/ A
输出参数:N/ A
返回值:NSUInteger :房间数量。
**********************************************************/
- (NSUInteger)showFiveAndSixStairRoomCount
5)不必每 都加注释，在3~10左右的段落做注释要好于每 都做注释，显 易 的代码不加注释。
例如:
If (!returnValue)
{
NSLog(@”登录失败”);
}
3.3、编码排版格式
1)代码的缩进应使 空格(SPACE)，不能使 制表符(TAB)，并且缩进以2个字符为单位。
2)中括弧的每 个括弧在源程序中要单独占 。例如
//不正确 法
for (int i = 0; i < 10 ; i++){
}
//正确用法
for (int i = 0; i < 10; i++)
{
......
}
3)空格的使
a)关键字与其后的表达式之间要有空格，如:
if ( expr )
或
for (expr)
b)单 操作符不应与它们的操作数分开(如’!’和’^’等)。
c)除’ , ’外，其它双目操作符应与它们的操作数用空格隔开。
例如
i=i+1;//错误的写法，操作符两端没有空格
i = i + 1;//正确的写法，
if(a>b)//错误的写法，逻辑判断符号两端没有空格
if(a > b)//正确的写法
d) .h中协议<>前面有一个空格。
e) .h中成员声明时，类型与变量之间有至少1个空格。*号靠近变量，不靠近类型。
f) @property后留1个空格，()里面，逗号紧跟前一变量，与后一变量之间留1个空
格。()外面，先留1个空格，再声明属性。
g)方法的+，-后面与()之间留1个空格。
h)返回类型与*之间留1个空格，方法参数中返回类型与*之间留1个空格。
i)在多参数方法中，每个参数后面都有1个空格。
4)每行只能有一个语句
例如
//不正确写法
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;
5)关于空行
a) .h中的空行
、文件说明与头文件包含(#import)之间空1行
、头文件包含(#import)之间，如果需要分类区别，各类别之间空1行。
、头文件包含(#import)与@class之间空2行。
、@interface与@class之间空1行。
、头文件{}里面，空1行开始声明对象成员，如果需要分类区别，各类别之间空1
行。
、头文件{}外，空1行书写属性，如果需要分类区别，各类别之间空1行。
、属性下面空1行开始写方法，如果需要分类区别，各类别之间空1行。
、方法完成后，空1行@end。
、如果需要声明protocol，空2行接着写。通常protocol写在@end后面，但是声明
在@interface之前。
b) .m中的空行
、文件说明与头文件包含(#import)之间空1行
、头文件包含(#import)之间，如果需要分类区别，各类别之间空1行。
、@implementation和@synthesize之间空1行,如果需要分类区别，各类别之间
空1行。
、@synthesize与方法之间空1行。
、方法与方法之间空1行。
C)方法里面的空行
、变量声明后需要空1行，如果需要分类区别，各类别之间空1行。
、条件、循环，选择语句，整个语句结束，需要空1行。
、各功能快之间空1行。
、最后一个括弧之前不空行。
、注释与代码之间不空行。
、#pragma mark与方法之间空1行。
d)每行代码最多不得操作100个字。设置如下:Xcode => Preferences => TextEditing
=> Page Guide at column /输入100即可。
3.2、命名规范
3.2.1、保留字
Objective-c语言的保留字或关键词应全部使用小写字母，除下表中保留字外，private、protected、public、在类型说明中也作为保留字使用。还有nonatomanic,retain,readwrite,
readonly等也有特殊的使用场合。
_Bool，_Complex，_Imaginary，auto，break，bycopy，byref，case，char，const，continue
，default，do，double，else，enum，extern，float，for，goto，if，in，inline
，inout，int，long，oneway，out，register，restrict，return，self，short，signed，sizeof，static，
struct，super，switch，typedef，union，unsigned，void，volatile，while
3.2.2、方法
1)方法的名称应全部使用有意义的单词组成，且以小写字母开头，多单词组合时，后面的单词
首字母大写。
例如:
-(void)getUserInformation......
2)设置类变量的内容的方法应使用set作为前缀，读取变量的内容的方法应使用get作为前缀。
例如:
-(void)getUserName;
-(void)setUserName:(NSString *)userName;
3)方法中的参数:第一个参数名称要从函数名称上携带出来，第二个参数的首字母小写，多个
单词组合时，后面单词首字母大写。参数有别名时，参数别名与参数名一致，但参数名前缀
以_。参数别名与前一参数保留1个空格。参数无别名时，以有意义的字母命名。
例如:
-(void)myFunctionWithSizeA:(CGSize)sizeA sizeB:(CGSize)_sizeB;
3.2.3、变量
1)变量必须起有意义的名字，使其他组员可以很容易读懂变量所代表的意义，变量命名可以采
用同义的英文命名，可使用几个英文单词，第一个单词首字母小写，其他单词首字母大写。
例如:
NSString *username;
2)对于一些特殊类型的变量，命名时要带上类型，如NSArray的变量命名为xxxArray，其他的
如xxxDictionary，xxxSize等。这样就可以从名称上知道是什么类型的变量。千万不能将
NS Array的变量命名为xxxDictionary。
3)对于要和interface builder关联的的输出口变量，命名时要后缀以特定的控件名。
例如:IBOutlet UILabel *userNameLabel;
4)对于使c语 形式声明的变量， 些特定类型可采 定的简写:
例如:
指针类型:P
结构体类型:Rec
数组类型:Arr
Core Graphic:CG等。
循环控制变量通常使 单 的字符如:i、j、k等。使 有意义的名字，如
objectIndex也是可以的。
5)尽量避免使 全局变量，如果必须使 全局变量则必须加前缀‘ Pub_’,同时应在变量名称中体现变量的类型。
6)私有实例变量前加一个下划线，如_myPrivateVarible。
7)枚举变量也要有相应的前缀来区分不同的enum变量。比如苹果公司的一个enum。
例如:
typedef enum CGPathDrawingMode CGPathDrawingMode;
/* Drawing modes for text. */
enum CGTextDrawingMode
{
kCGTextFill,
kCGTextStroke,
kCGTextFillStroke,
kCGTextInvisible,
kCGTextFillClip,
kCGTextStrokeClip,
kCGTextFillStrokeClip,
kCGTextClip
};
3.2.4、常量
1)避免在程序中直接出现常数，使用超过一次的应以宏定义的形式来替代。
2)常数的宏定义应与它实际使用时的类型相一致。如以3.0来定义浮点类型，用3表示整型。
3)常量的命名应当能够表达出它的用途，并且用大写字母表示。
例如:#define PI 3.1415926
4)一些常量前加特殊前缀，可以作为不同常量的区分，
例如:
UserDefaultsKey的变量前加UDKEY_,
UserDefaultsKey的变量前加UDKEY_,
NotificationNameKey前面加NNKEY_,
DictionaryKey前面加DICTKEY_,
3.2.5、类
1)所有的类名，接口名(Protocol)均以大写字母开头，多单词组合时，后面的单词首字
母大写。类，接口名必须是有意义的。
2)继承自UIView的类以View结尾。
例如:OperatorUsersInfomationView，LabelView等。
3)继承自ViewController的类以viewController结尾。
例如:HomePageViewController，LoginViewController等。其他类推。
4)所有保存数据的实体以Model结尾。例如:
UserModel，
3.2.5、图片
基本格式为:模块描述+功能描述+其它描述
如下:
1)如公共模块的图片，以Common开头
CommonDelete@2x.png
2)如通讯录模块的图片，以ADB开头
AdbAddGroup@2x.png
3.2.5、控件ID
基本格式为:控件类型+模块描述+功能描述+其它描述
如下:
1)如通讯录模块的删除群组按钮ID名称，可以使用以下命名
btnADBDeleteGroup
3.3、修改规范
3.5.1、新增代码行
新增代码行的前后应有注释行说明。
//修改人，修改时间，修改说明
新增代码行
//修改结束
3.3.2、删除代码行
删除代码向的前后用注释行说明
//修改人，修改时间，修改说明
要删除的代码行(将要删除的语句进行注释)
//修改结束
3.3.3、修改代码行
修改代码行以注释旧代码行后再新增代码行的方式进行。
//修改人，修改时间，修改说明
//修改前代码行开始
//修改前代码行
//修改前代码行结束
//修改后代码行开始修改后代码行
//修改结束
网友评论