iOS团队编码规范

不规范的代码,读起来身心俱惫,改起来后患无穷。

命名原则:

1.最少字符,尽量的减少命名对象的长度,选择字符少的名词

2.名符其实,命名应该能直观的描述被命名对象是什么或者做什么

3.避免歧义,尽量不要采用多义词,也不要使用命名组合之后产生多义的方式

4.上下文一致,比如谓词的统一性,如果都是集合类,那么使用Remove表示删除操作,那么所有上下文就应该都用这个Remove,而不要再用Delete

5.少用缩写,除非是很常见的缩写或者项目中定义好的缩写,否则不要使用缩写

6.优先使用全局常量而非宏,应使用static方式声明常量;

一、目录命名

以功能模块划分目录,使用大驼峰法命名,例:Discovery,并关联实体文件夹。


二、类命名

遵循命名原则,使用大驼峰法命名,通常在类的头部.h文件添加类注释,标明该类的用途。


三、属性命名

1. 一般变量名使用小驼峰命名规则,不要使用下划线。


2. 类属性变量用小驼峰法。


3. 类的成员变量用小驼峰命名法并加上下划线开头的方式命名。


四、方法命名

使用小驼峰法命名,方法名使用动词短语,能具体表达出该方法的功能,参照系统方法:


更多编码规范请参考:https://github.com/raywenderlich/objective-c-style-guide


注释规范

链接到另一篇文章:iOS代码注释方法大全,图文介绍如何使用快速注释

文章介绍各类注释方法、应用场景,并搭配快捷键实现快速注释。


以上属于臭码农原创,若有雷同属巧合,如有错误望指正,转载请标明来源和作者。by:臭码农

转载于:https://juejin.im/post/5a323eaf6fb9a045211ebaff

评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值