iOS项目的命名规范
一、关于本文档
1、本文档的书写目的
《iOS项目的命名规范》的书写目的,在于让后续参加到该项目的iOS开发人员通过阅读该文档,了解在当前iOS项目的代码中的命名要求并严格按照本文档执行,以便保证代码的更好阅读与维护。
2、本文档的使用范围
《iOS项目的命名规范》在iOS项目中被强制要求执行。将本文中的WSF或者wsf替换成代表项目的前缀(请用三个大写字母),即可用于其他iOS项目。
3、本文档的更新负责人
《iOS项目的命名规范》由本ID和同事共同协商讨论制定,由本ID负责编辑、修改和后续的版本更新。
二、目录结构
三、新建【业务模块文件夹】
1、文件夹的名称需要体现该模块的功能概括。
比如:支付系统、订单
2、二级文件夹根据编程设计模式分类命名,需要从下面词语中取词:
ViewModel、Model、View、ViewController、其他
四、新建【子类】
1、类名
(1)遵循大驼峰命名法。
(2)WSF+模块概括名+功能分区名+父类的惯用后缀。比如:WSFOrderListVC
(3)为了整个项目代码的整洁与统一,建议使用List、Detail、Message、TView、Cell、VC、TVC、VM等字样。
(4)模块概括名一定要是统一的、明确的、唯一的代表模块名称。
(5)父类的惯用后缀的意思是:如果要从其他框架继承子类,那么必须遵循其命名惯例。比如,继承UIView的子类名称必须以View结尾。
2、属性名
(1)遵循小驼峰命名法、避免缩写。
(2)后缀体现属性的数据类型。比如:orderPriceLabel、orderLimitsArray。
(3)使用长的、描述性的命名方向。比如settingButton而不是setBtn。
(4)要求NSString *nameString; 而不是NSString* nameString; 或者NSString * nameString;。
3、属性定义
(1)定义属性的参数顺序排序:原子性、读写、内存管理。比如:@property (nonatomic, readwrite, copy) NSString *nameString;
(2)BOOL类型的属性,需要为其getter方法带is前缀。getter方法放在内存管理限定符前面,比如:@property (nonatomic, readonly, getter=isEditable, assign) BOOL editable;
4、实例变量名
(3)下划线开头
(2)遵循小驼峰命名法、避免缩写。
(3)后缀体现属性的数据类型。比如:_orderPriceLabel、_orderLimitsArray。
5、公有方法名
(1)遵循小驼峰命名法、避免缩写。
(2)不要使用“and”这个词,它不应该用来阐明有多个参数。
6、私有方法名
(1)遵循小驼峰命名法、避免缩写。
(2)父类是Cocoa框架:p_开头。
(3)父类是其他框架:以自己一贯的前缀(小写)+下划线开头或者wsf_。比如:abc_、wsf_。
7、纯C函数
(1)遵循小驼峰命名法、避免缩写。
(2)加上WSF为前缀。
8、全局变量
.h文件
extern NSTimeInterval WSFPersonModelAnimationDuration;
extern NSString *WSFPersonModelErrorMessage;
.m文件
NSTimeInterval WSFPersonModelAnimationDuration = 0.3;
NSString *WSFPersonModelErrorMessage = @“ErrorMessage”;
(1)遵循大驼峰命名法、避免缩写。
9、枚举名
(1)遵循大驼峰命名法、避免缩写。
(2)使用OC的枚举方式。
(3)枚举对象名:WSF+枚举范围概括名+Type。比如:WSFAlipayResultCodeType
(4)枚举种类名:WSF+枚举范围概括名+Type_某种情况名。比如:WSFAlipayResultCodeType_success。
10、协议名
(1)遵循大驼峰命名法、避免缩写。
(2)代理协议:类名+Delegate。比如:WSFOrderListChangedDelegate。
(3)数据源协议:类名+DataSource。比如:WSFOrderListDataSource。
(4)普通协议:类名+Protocol。比如:WSFOrderListVCProtocol。
五、新建【分类】
1、分类名
(1)类名+标识前缀+扩展标识。
(2)遵循大驼峰命名法、避免缩写。
(3)WSF或者自己一贯使用前缀(大写)+下划线为前缀。比如:NSString (WSF_HTTPManager)、NSString(ABC_HTTPManager)。
2、方法名
(1)遵循小驼峰命名法、避免缩写。
(2)wsf或者自己一贯使用前缀(小写)+下划线为前缀。比如:- (void)wsf_urlEncodedString;、- (void)abc_urlEncodedString;
六、新建【协议】
1、协议名
(1)遵循大驼峰命名法、避免缩写。
2、方法名
(1)遵循小驼峰命名法、避免缩写。
(2)如果是代理协议,以发送代理的对象类名作为代理方法名的开始(去掉类名的前缀,并且遵循小驼峰命名法)。
七、新建【第三方库的封装】
(1)手动管理:比如使用MJRefresh框架,需要将它的类名全部加前缀以避免命名空间冲突。比如:命名为WSFMJRefresh。
(2)pod管理:不需要特殊处理。
八、新建【常量】
1、私有常量
.m文件
static const NSTimeInterval kAnimationDuration = 0.3;
static NSString *const kErrorMessage = @“ErrorMessage”;
2、公开常量
.h文件
extern const NSTimeInterval WSFPersonModelAnimationDuration;
extern NSString *const WSFPersonModelErrorMessage;
.m文件
const NSTimeInterval WSFPersonModelAnimationDuration = 0.3;
NSString *const WSFPersonModelErrorMessage = @“ErrorMessage”;
说明:
(1)遵循小驼峰命名法、避免缩写。
(2)在声明公开常量时,也可以使用FOUNDATION_EXPORT替换extern。
3、常量名称的常用命名方法:若常量局限于某“编译单元”,也就是“实现文件”之内,则在前面加字母k;若常量在类之外可见,则通常以WSF+类名为前缀。
九、新建【通知】
1、按照公共常量方法处理。
2、以Notification为后缀。
iOS项目的命名规范的更多相关文章
- SSH框架项目开发命名规范
SSH 框架项目开发命名规范 一.各层包及类命名规范 总体原则:包名所有字母小写,类名采用 "驼峰标识",具体如下: 1. Action 类 包命名规范:co ...
- iOS-OC命名规范
IOS开发(OC)中的命名规范 正文:通过读写大量代码我有自己的一套编程思路和习惯,自认为自己的编码习惯还是不错的,代码结构也算清晰,因为我一直以来都是代码看的多写的多,但是总结的比较少,知识经常不成 ...
- iOS项目重命名以及Xcode修改Scheme名称图文详解 (yoowei)
在iOS开发中,有时候想改一下项目的名字,都会遇到很多麻烦.温馨提醒:记得备份. 看到项目名称,总感觉有点low,所以尝试着要将其更改一下. 项目原结构如下: 更改后的项目结构如下: 下面开始更改操作 ...
- Javaweb项目的命名规范
项目名称:一般是英文 包名:公司域名的倒写,例如com.baidu 数据访问层:dao,persist,mapper 实体:entity,model,bean,javabean,pojo 业务逻辑:s ...
- [旧][Android] 命名规范和编码规范
备注 原发表于2016.05.07,资料已过时,仅作备份,谨慎参考 前言 本文适用范围:已参加项目开发的人 写这篇文章的目的是为方便地对代码进行管理,让整个团队的代码规范化.这里的部分规定可能和你在其 ...
- iOS开发(OC)中的命名规范
开小差:最近发现自己有一个经验主义的毛病,不太容易接受新的知识,这对从事技术研发的人来说不太合理,需要改之. 正文:通过读写大量代码我有自己的一套编程思路和习惯,自认为自己的编码习惯还是不错的,代码结 ...
- ios开发之--编码及命名规范
做了几年的开发工作,因为是半路出的家,所以对这块一直都没怎么重视,所以在工作中,出现了很多的尴尬场景,编码和命名的规范是一定得有的,最起码一个团队之间的规范也是很有必要的.面向对象的编程,其实很好理解 ...
- ios项目icon和default图片命名规则
一.应用图片标准iOS控件里的图片资源,苹果已经做了相应的升级,我们需要操心的是应用自己的图片资源.就像当初为了支持iPhone 4而制作的@2x高分辨率版本(译者:以下简称高分)图片一样,我们要为i ...
- java项目命名规范
一.命名规范 1. 项目名全部小写 2. 包名全部小写 3. 类名首字母大写,如果类名由多个单词组成,每个单词的首字母都要大写. 如:public class MyFirstClass{} 4. 变量 ...
随机推荐
- (图文实例)用VB.net操作SQLite数据库
转载请注明出处:HateMath归来(http://www.cnblogs.com/hatemath/) 环境: Visual Studio 社区版 64位 Windows 7系统 新建的解决方案基于 ...
- 提纲挈领webrtc之NS(noise suppression)模块
Noise suppression,就是大家说的降噪.这种降噪是把人声和非人声区分开来,把非人声当成噪声. 一段包含人声和噪声的音频经过该模块处理,从理论上讲,只剩下人声了. webrtc的NS在业内 ...
- linux_base_commond_two
1.linux privilege commond a.throught ll commond can get follow picture d directory - file l ...
- UVa11882,Biggest Number
搜索+剪枝 如此水的一个题,居然搞了一上午 出错在bfs与dfs时共用了一个vis数组,导致bfs完后返回dfs应该能访问到的点访问不到 自己想怎么剪枝,想了几个剪枝方法,又证明,又推翻,再想,再证明 ...
- js 中 new fn与new fn()的区别
在有些代码中,看见了let fn = new Fn()和let fn = new Fn,刚开始有些人或许和我一样感到些许疑惑,但潜意识的也会想到,这两者说不定就是一样的.没错!!在没有参数的情况下这两 ...
- web前端——10个妨碍进步的学习方式
1.前言 从事web前端的人很多,每个人的学习方式,学习习惯基本不会一模一样!关于web前端(或者直接互联网),大家都知道,是做到老,学到老的一个行业.之前写文章的时候,我说过很多学习的方式和建议.今 ...
- java遍历hashMap、hashSet、Hashtable
一.遍历HashMap Map<Integer, String> map = new HashMap<Integer, String>(); 方法一:效率高 for(Entry ...
- Servlet 笔记-生命周期
Servlet 生命周期可被定义为从创建直到毁灭的整个过程.以下是 Servlet 遵循的过程: Servlet 通过调用 init () 方法进行初始化. Servlet 调用 service() ...
- MySQL技术内幕汇总
MySql技术内幕之MySQL入门(1) MySql技术内幕之MySQL入门(1) 检查系统中是否已经安装了MySQL sudo netstat -tap | grep mysql 若没有显示已安装结 ...
- LeetCode 80. Remove Duplicates from Sorted Array II (从有序序列里移除重复项之二)
Follow up for "Remove Duplicates":What if duplicates are allowed at most twice? For exampl ...