命名
- 命名统一使用驼峰命名法;只采纳有广为人知含义的缩写,比如info、msg、UI、HTTP这类。自造的缩写不被认可。总体的命名原则是清晰和一致,避免歧义,同样要确保类名需要大写字母开头。
- 公共类名需要结合项目名称来命名,确保整个项目中的自定义类的名称开头是统一的。
- 模块内类名命名需结合功能或者模块,并且尾部要带上该类的类型,比如UIViewController的子类命名为JasonIndexController。
- 成员变量命名小写字母开头,使用下划线作为变量的前缀;属性和局部变量命名不需要使用下划线作为变量的前缀或者后缀,全局变量使用下划线作为变量的后缀。
- 方法命名小写字母开头(方法以大写缩略词开始的除外),文件夹首字母大写开头。不要使用下划线开头作为方法的前缀。
- 项目中所有Group或者文件名称(图片名字等),不要使用汉字命名,尽量使用英文命名,国内特有名词可以使用拼音。
- 图片命名以英文小写“模块名_图片名”来命名,并且同样不能使用中文。
Objective-C下的cocoa编码规范
- 使用
#pragma mark
来分类方法,参考以下结构:#pragma mark – Life Cycle
。 - .h文件中使用
@class
声明OC文件; .m文件中使用#import
引入oc文件。 - 尽量减少公开的api接口数量
- 枚举的定义使用如下的方式:
typedef NS_ENUM(NSUInteger, UISearchBarStyle) { UISearchBarStyleDefault, // currently UISearchBarStyleProminent UISearchBarStyleProminent, // used my Mail, Messages and Contacts UISearchBarStyleMinimal // used by Calendar, Notes and Music }
注释要求
新版Xcode自带有添加注释的功能
- 单行注释:在方法的地方按 Command+/
- 方法注释,快捷键是Command + Option + /(需要在方法名的上面(空白)的地方按 Command + Option + / 才管用)
- 在新建一个类的时候,需要在头文件中添加注释,来表明这个类的作用。
- 一些过于简单的注释尽量不要加。
其他
- 懒加载代码放在最底部
网友评论