Object-C编码规范V1.0

《Object-C编码规范V1.0》由会员上传分享，免费在线阅读，更多相关内容在教育资源-天天文库。

1、Ó北京陆优科技有限公司java编码规范Object-C编码规范当前版本0.10密级机密文档编号总页数正文页数附录页数0第14页，共15页Ó北京陆优科技有限公司java编码规范编制人王春评审人批准人编制日期2014.09.02评审日期批准日期修改履历序号状态版本修改内容修改位置修改人日期评审人日期批准人日期1C0.10创建Object-C编码规范文档初稿。王春2014.09.0223456第14页，共15页Ó北京陆优科技有限公司java编码规范7891011121314状态：C—创建文档，A—增加内容，M—修

2、改内容，D—删除内容目录1引言41.1目的41.2适用范围41.3定义、首字母缩写词和缩略语42编码规范42.1文件42.2注释52.3编码排版格式72.4命名规范9第14页，共15页Ó北京陆优科技有限公司java编码规范2.5修改规范132.5.1.新增代码行132.5.2.删除代码行132.5.3.修改代码行13第14页，共15页Ó北京陆优科技有限公司java编码规范1引言1.1目的统一规范XCode编辑环境下Objective-C的编码风格，提高程序的可读性、可测试性和可维护性，同时提高项目整体效率和

3、研发交付物质量。遵循编码规范有助于标准化程序结构和编码风格，使源代码对于自己和别人都易读、易懂。良好的编码习惯除了代码格式，详细的注释外，还应该包括使用有助于提高代码效率的编码方式。1.2适用范围此文档适用于所有IOS开发人员。1.3定义、首字母缩写词和缩略语Ø定义：术语定义Ø缩略语：名称命名名称命名2编码规范2.1文件1.第14页，共15页Ó北京陆优科技有限公司java编码规范项目文件必须使用一个有意义的名字且前缀以PRJ_。例如：XCcode中下拉刷新的项目文件被命名为’PRJ_PullDownRefr

4、esh.xcodeproj’。1.公共文件统一命名为’Public.h’。任何文件的命名尽量不要以中文命名。2.对于文件的目录要按如下结构创建：-Document（文档所在路径）-Help（帮助文件所在路径）-图片等资源文件放在单独的目录与组(Group)中，如Images。-所有的view放在单独的组(Group)中，如CustomView。-所有的viewController放在单独的组中，如viewControllers。-引用外部文件或者某个单独的功能时，放在单独的组中，例如：程序中使用了cover

5、flow功能，引用openflow的文件时，将其全部文件放在openFlow这个组中。其view和viewcontroller等文件的组织不受上面所规定的影响。1.1注释1.注释可以采用’/**/’和’//’两种注释符号，涉及到多行注释时，尽量使用’/**/’。2.对于一行代码的注释可放在前一行及本行上，不允许放在下一行，更不允许在一行语句的中间加入注释。3.单元文件的文件头注释说明应按如下格式：/***Company：LuyouChinaCo.,Ltd.*CopyRight：2013-2014,Luyou

6、ChinaCo.,Ltd.*Author：白勇*CreateDate：2014-09-03*FileName:：LYAppDelegate.h*ProjectName:：铁道培训在线*Desc：*/第14页，共15页Ó北京陆优科技有限公司java编码规范1.方法前面的注释遵循以下格式：如果某项没有，则以N/A表示例如：/**********************************************************函数名称：-(BOOL)showFiveAndSixStairRoomCo

7、untByStatu函数描述：显示特定状态下五楼和六楼的房间数输入参数：(NSString*)statu：某状态。输出参数：(int*)roomCount：该状态房间数量。返回值：BOOL：操作是否成功。**********************************************************/-(void)ShowFiveAndSixStairRoomCountByStatu:(NSString*)staturoomCount:(int*)_roomCount;或/*******

8、***************************************************函数名称：-(NSUInteger)showFiveAndSixStairRoomCount函数描述：显示五楼六楼的房间数。输入参数：N/A输出参数：N/A返回值：NSUInteger:房间数量。**********************************************************/