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

文档介绍：该【IOS开发编码及命名规范 】是由【花双韵芝】上传分享，文档一共【7】页，该文档可以免费在线阅读，需要了解更多关于【IOS开发编码及命名规范 】的内容，可以使用淘豆网的站内搜索功能，选择自己适合的文档，以下文字是截取该文章内的部分文字，如需要获得完整电子版，请下载此文档到您的设备，方便您编辑和打印。IOS开发编码及命名规范
目录
1、目的.......................................................
2、适用范围...................................................
3、编码规范...................................................
、文件....................................................
、说明....................................................
、编码排版格式............................................
、命名规范................................................
、保留字..............................................
、方法................................................
、变量................................................
、常量................................................
、类..................................................
、更正规范................................................
、新增代码行..........................................
、删除代码行..........................................
、更正代码行..........................................

错误!不决义书签。
错误!不决义书签。
错误!不决义书签。
错误!不决义书签。
错误!不决义书签。
错误!不决义书签。
错误!不决义书签。
错误!不决义书签。
错误!不决义书签。
错误!不决义书签。
错误!不决义书签。
错误!不决义书签。
错误!不决义书签。
错误!不决义书签。
错误!不决义书签。
错误!不决义书签。
1、目的
一致规范XCode编写环境下Objective-C的编码风格和标准
2、适用范围
适用于所适用Objective-C语言开发的项目。
3、编码规范
、文件
项目文件都是使用因文命名。
公共文件一致命名为’’。任何文件的命名尽量不要以中文命名。
对于文件的目录要按以下结构创办:
图片等资源文件放在。
-全部的三方库在单独的组(Group)中,如ThirdPartLibrary。
-全部的分类跟封装放在单独的组中,如Common。
、说明
1)说明能够采用’

/**/

’和’

Allrightsreserved.
中协议<>前面有一个空格。
e).h中成员声明时,种类与变量之间有最少

1个空格。

*号凑近变量,不凑近类
型。
***@property后留1个空格,()里面,逗号紧跟前一变量,与后一变量之间留
个空格。()外面,先留1个空格,再声明属性。
方法的+,-后边与()之间留1个空格。
h)返回种类与*之间留1个空格,方法参数中返回种类与*之间留1个空格。
i)在多参数方法中,每个参数后边都有1个空格。
4)每行只能有一个语句
比方
中的空行
(#import)之间空1行
○、文件说明与头文件包含
1
1行。
○、头文件包含(#import)
之间,若是需要分类差异,各样型之间空
2
与***@class之间空2行。
○、头文件包含(#import)
3
○4、***@interface与***@class之间空1行。
○5、头文件{}里面,空1行开始声明对象成员,若是需要分类差异,各样型之
间空1行。
1行。
○、头文件{}外,空1行书写属性,若是需要分类差异,各样型之间空
6
○、属性下面空1行开始写方法,若是需要分类差异,各样型之间空
1行。
7
1行***@end。
○、方法完成后,空
8
○、若是需要声明protocol
,空2行接着写。平时
protocol
写在***@end后边,
9
但是声明在***@interface
从前。
b).m
中的空行
(#import)之间空1行
○、文件说明与头文件包含
1
1行。
○、头文件包含(#import)
之间,若是需要分类差异,各样型之间空
2
○、***@implementation
和***@synthesize之间空1行,
若是需要分类差异,各样
3
别之间空1行。
○、***@synthesize与方法之间空1行。
4
○、方法与方法之间空
1行。
5
C)
方法里面的空行
1行,若是需要分类差异,各样型之间空
1行。
○、变量声明后需要空
1
1行。
○、条件、循环,选择语句,整个语句结束,需要空
2
○、各功能快之间空
1行。
3
○4、最后一个括弧从前不空行。
○5、说明与代码之间不空行。
○6、#pragmamark与方法之间空1行。
每行代码最多不得操作100个字。设置以下:Xcode=>Preferences=>TextEditing
=>PageGuideatcolumn/输入100即可。
、命名规范
、保留字
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
、方法
方法的名称应全部使用有意义的单词组成,且以小写字母开头,多单词组合时,后边的单词首字母大写。
比方:
-(void)getUserInformation
2)设置类变量的内容的方法应使用

set

作为前缀,读取变量的内容的方法应使用

get

作为
前缀。
比方:
-(void)getUserName;
-(void)setUserName:(NSString*)userName;
方法中的参数:第一个参数名称要从函数名称上携带出来,第二个参数的首字母小写,多个单词组合时,后边单词首字母大写。参数有别名时,参数别名与参数名一致,但参
数名前缀以_。参数别名与前一参数保留1个空格。参数无别名时,以有意义的字母命名。比方:
-(void)myFunctionWithSizeA:(CGSize)sizeAsizeB:(CGSize)_sizeB;
、变量
变量必定起有意义的名字,使其他组员能够很简单读懂变量所代表的意义,变量命名能够采用同义的英文命名,可使用几个英文单词,第一个单词首字母小写,其他单词首字
母大写。
比方:
NSString*username;
2)对于一些特别种类的变量,命名时要带上种类,如NSArray的变量命名为xxxArray
他的如xxxDictionary,xxxSize等。这样就可以从名称上知道是什么种类的变量。
不能够将NSArray的变量命名为xxxDictionary。

,其
千万
对于要和interfacebuilder关系的的输出口变量,命名时要后缀以特定的控件名。比方:
IBOutletUILabel*userNameLabel;
对于使用c语言形式声明的变量,一些特定种类可采用必然的简写:比方:
指针种类:P
结构体种类:Rec
数组种类:Arr
CoreGraphic

:CG
等。
循环控制变量平时使用单一的字符如:i、j、k等。使用有意义的名字,如objectIndex
也是能够的。
5)尽量防备使用全局变量,若是必定使用全局变量则必定加前缀‘Pub_’,同时应在
变量名称中表现变量的种类。
私有实例变量前加一个下划线,如_myPrivateVarible。
列举变量也要有相应的前缀来区分不同样的enum变量。比方苹果公司的一个enum。
比方:
typedefenumCGPathDrawingModeCGPathDrawingMode;
/*Drawingmodesfortext.*/
enumCGTextDrawingMode
{
kCGTextFill,
kCGTextStroke,
kCGTextFillStroke,
kCGTextInvisible,
kCGTextFillClip,
kCGTextStrokeClip,
kCGTextFillStrokeClip,
kCGTextClip
};
、常量
防备在程序中直接出现常数,使用高出一次的应以宏定义的形式来取代。
2)
常数的宏定义应与它实质使用时的种类相一致。如以来定义浮点种类,用
3表示整
型。
3)
常量的命名应当能够表达出它的用途,并且用大写字母表示。
比方:
#definePI
、类
全部的类名,接口名(Protocol)均以大写字母开头,多单词组合时,后边的单词首字母大写。类,接口名必定是有意义的。
继承自UIView的类以View结尾。比方:
BorderCircularView,LabelView等。
3)继承自UITableViewController的类以viewController结尾。
比方:
BaseTableViewController等。其他类推。
、更正规范
、新增代码行
新增代码行的前后应有说明行说明。
更正人,更正时间,更正说明新增代码行
更正结束
、删除代码行
删除代码向的前后用说明行说明
更正人,更正时间,更正说明
要删除的代码行(将要删除的语句进行说明)
更正结束
、更正代码行
更正代码行以说明旧代码行后再新增代码行的方式进行。
更正人,更正时间,更正说明
更正前代码行开始
更正前代码行
更正前代码行结束
更正后代码行开始更正后代码行
更正结束