欢迎来到天天文库
浏览记录
ID:51802561
大小:87.00 KB
页数:9页
时间:2020-03-15
《IOS开发编码及命名规范.doc》由会员上传分享,免费在线阅读,更多相关内容在教育资源-天天文库。
1、IOS开发编码及命名规范9/9目录1、目的32、适用范围33、编码规范33.1、文件33.2、注释33.3、编码排版格式43.4、命名规范63.4.1、保留字63.4.2、方法73.4.3、变量73.4.4、常量83.4.5、类83.5、修改规范93.5.1、新增代码行93.5.2、删除代码行93.5.3、修改代码行99/91、目的统一规范XCode编辑环境下Objective-C的编码风格和标准2、适用范围适用于所有用Objective-C语言开发的项目。3、编码规范3.1、文件1)项目文件必须使用一个有意义的名字且前缀以PRJ_。例如:XCcode中下拉刷新的项目文件被命名为’
2、PRJ_PullDownRefresh.xcodeproj’。2)公共文件统一命名为’Public.h’。任何文件的命名尽量不要以中文命名。3)对于文件的目录要按如下结构创建:-Document(文档所在路径)-Help(帮助文件所在路径)-图片等资源文件放在单独的目录与组(Group)中,如Images。-所有的view放在单独的组(Group)中,如CustomView。-所有的viewController放在单独的组中,如viewControllers。-引用外部文件或者某个单独的功能时,放在单独的组中,例如:程序中使用了coverflow功能,引用openflow的文件时,
3、将其全部文件放在openFlow这个组中。其view和viewcontroller等文件的组织不受上面所规定的影响。3.2、注释1)注释可以采用’/**/’和’//’两种注释符号,涉及到多行注释时,尽量使用’/**/’。2)对于一行代码的注释可放在前一行及本行上,不允许放在下一行,更不允许在一行语句的中间加入注释。3)单元文件的文件头注释说明应按如下格式:////文件名//工程名////Createdby创建者on日期.9/9//Copyright2010xxx有限公司.Allrightsreserved.////系统名称://功能描述://修改记录:(仅记录功能修改)//张三20
4、12-02-02创建该单元//小明2010-03-02增加本地点单功能。//4)方法前面的注释遵循以下格式:如果某项没有,则以N/A表示例如:/**********************************************************函数名称:-(BOOL)showFiveAndSixStairRoomCountByStatu函数描述:显示特定状态下五楼和六楼的房间数输入参数:(NSString*)statu:某状态。输出参数:(int*)roomCount:该状态房间数量。返回值:BOOL:操作是否成功。*************************
5、*********************************/-(void)ShowFiveAndSixStairRoomCountByStatu:(NSString*)staturoomCount:(int*)_roomCount;或/**********************************************************函数名称:-(NSUInteger)showFiveAndSixStairRoomCount函数描述:显示五楼六楼的房间数。输入参数:N/A输出参数:N/A返回值:NSUInteger:房间数量。****************
6、******************************************/-(NSUInteger)showFiveAndSixStairRoomCount5)不必每行都加注释,在3~10行左右的段落做注释要好于每行都做注释,显而易见的代码不加注释。例如:If(!returnValue)//调用登录过程失败ß无用的注释{NSLog(@”登录失败”);}3.3、编码排版格式1)代码的缩进应使用空格(SPACE),不能使用制表符(TAB),并且缩进以2个字符为单位。2)中括弧的每一个括弧在源程序中要单独占一行。例如//不正确用法9/9for(inti=0;i<10;i++)
7、{}//正确用法for(inti=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)
此文档下载收益归作者所有