- 1、本文档共10页,可阅读全部内容。
- 2、有哪些信誉好的足球投注网站(book118)网站文档一经付费(服务费),不意味着购买了该文档的版权,仅供个人/单位学习、研究之用,不得用于商业用途,未经授权,严禁复制、发行、汇编、翻译或者网络传播等,侵权必究。
- 3、本站所有内容均由合作方或网友上传,本站不对文档的完整性、权威性及其观点立场正确性做任何保证或承诺!文档内容仅供研究参考,付费前请自行鉴别。如您付费,意味着您自己接受本站规则且自行承担风险,本站不退款、不进行额外附加服务;查看《如何避免下载的几个坑》。如果您已付费下载过本站文档,您可以点击 这里二次下载。
- 4、如文档侵犯商业秘密、侵犯著作权、侵犯人身权等,请点击“版权申诉”(推荐),也可以打举报电话:400-050-0827(电话支持时间:9:00-18:30)。
查看更多
IOS编码及注释规范IS编码及注释规范
PAGE10 / NUMPAGES10
IOS开发编码及命名规范
目录
TOC \o 1-3 \h \z \u 1、目的 PAGEREF _Toc282254537 \h 3
2、适用范围 PAGEREF _Toc282254538 \h 3
3、编码规范 PAGEREF _Toc282254539 \h 3
3.1、文件 PAGEREF _Toc282254540 \h 3
3.2、注释 PAGEREF _Toc282254541 \h 3
3.3、编码排版格式 PAGEREF _Toc282254542 \h 5
3.4、命名规范 PAGEREF _Toc282254543 \h 6
3.4.1、保留字 PAGEREF _Toc282254544 \h 6
3.4.2、方法 PAGEREF _Toc282254545 \h 7
3.4.3、变量 PAGEREF _Toc282254546 \h 7
3.4.4、常量 PAGEREF _Toc282254547 \h 8
3.4.5、类 PAGEREF _Toc282254548 \h 9
3.4.6图片命名 PAGEREF _Toc282254549 \h 9
3.5、修改规范 PAGEREF _Toc282254550 \h 9
3.5.2、新增代码行 PAGEREF _Toc282254551 \h 9
3.5.2、删除代码行 PAGEREF _Toc282254552 \h 10
3.5.3、修改代码行 PAGEREF _Toc282254553 \h 10
3.5.4、其他规范 PAGEREF _Toc282254554 \h 10
1、目的
统一规范XCode编辑环境下Objective-C的编码风格和标准
2、适用范围
适用于所有用Objective-C语言开发的项目。
3、编码规范
3.1、文件
1) 项目文件必须使用一个有意义的名字一般用bundleId最后一位如lender .xcodeproj’。
2) 公共文件统一命名为’Public.h’。任何文件的命名尽量不要以中文命名。
3) 对于文件的目录要按如下结构创建:
-Document(文档所在路径)
-Help(帮助文件所在路径)
-图片等资源文件放在单独的目录与组(Group)中,如Images。
-所有的view放在单独的组(Group)中,如Custom View。
-所有的viewController放在单独的组中,如viewControllers。
-引用外部文件或者某个单独的功能时,放在单独的组中,
例如:
程序中使用了coverflow功能,引用openflow的文件时,将其全部文件放在openFlow这个组中。其view和viewcontroller等文件的组织不受上面所规定的影响。
4) bundleId命名:公司的域名反过来最后一位是项目名称一般越短越好
举例:com.ppdai.*(com.ppdai.lender)
3.2、注释
1) 注释可以采用’ /* */ ’和’ // ’两种注释符号,涉及到多行注释时,尽量使用
’ /* */ ’。
2) 对于一行代码的注释可放在前一行及本行上,不允许放在下一行,更不允许在一行语句的中间加入注释。
3) 单元文件的文件头注释说明应按如下格式:
//
// 文件名
// 工程名
//
// Created by 创建者 on 日期.
// Copyright 2010 xxx有限公司. All rights reserved.
//
// 系统名称:
// 功能描述:
// 修改记录:(仅记录功能修改)
// 张三 2012-02-02 创建该单元
// 小明 2010-03-02 增加本地点单功能。
//
4) 方法前面的注释遵循以下格式:如果某项没有,则以N/A表示
例如:
/**********************************************************
函数名称:-(BOOL)showFiveAndSixStairRoomCountByStatu
函数描述:显示特定状态下五楼和六楼的房间数
输入参数:(NSString *)statu:某状态。
输出参数:(int *)roomCount :该状态房间数量。
返回值:BOOL:操作是否成功。
您可能关注的文档
- Excel用法Exce用法.doc
- EXCEL、WORD基练习题EXCEL、WORD基础练习题.doc
- 江苏省泰州市姜堰区2015-2016学年高二政治上学期期中试题(必修)江苏省泰州市姜堰区2015-2016学年高二政治上学期期中试题(必修).doc
- 江苏省灌南高级中学高三生物复习:基因的分离定律 (第二课时)江苏省灌南高级中学高三生物复习:基因的分离定律 (第二课时).ppt
- FDMA通信系统设计FMA通信系统设计.doc
- flash cs3教案4flash cs3教案14.doc
- 江苏省灌南县实验中学八年级历史上册 第24课 国民党政权的崩溃学案(无答案) 北师大版江苏省灌南县实验中学八年级历史上册 第24课 国民党政权的崩溃学案(无答案) 北师大版.pdf
- flash cs3教案flash cs3教案5.doc
- 江苏省溧水高级中学2015-2016学年高二上学期12月学业水平测试地理试题江苏省溧水高级中学2015-2016学年高二上学期12月学业水平测试地理试题.pdf
- DGY系列说明书DGY列说明书.doc
文档评论(0)