ios代码规范

命名规范

小驼峰命名法(CamelCase):第一个单词小写字母开头,其他单词首字母大写;

大驼峰命名法(PascalCase):   所有首字母大写。

统一要求:含义清楚,尽量做到不需要看注释也能了解其作用,使用全称,不使用缩写。

1、类的命名

* 大驼峰式命名:每个单词的首字母都采用大写字母,   例子:MFHomePageViewController

* 后缀要求

            ViewController: 使用ViewController做后缀

            例子: HXHomeViewController

            View: 使用View做后缀

            例子:HXAlertView

            UITableViewCell:使用Cell做后缀

           例子: HXNewsTableViewCell

           Protocol: 使用Delegate作为后缀

           例子: UITableViewDelegate

           UI控件依次类推

2、宏命名

* 全部大写,单词间用 _ 分隔。[不带参数]

          例子: #define THIS_IS_AN_MACRO @"THIS_IS_AN_MACRO"

* 以字母 k 开头,后面遵循大驼峰命名。[不带参数]

          例子:#define kWidth self.frame.size.width

* 小驼峰命名。[带参数]

          #define getImageUrl(url) [NSURL URLWithString:[NSString stringWithFormat:@"%@%@",kBaseUrl,url]]

3、Enum

* Enum类型的命名与类的命名规则一致

* Enum中枚举内容的命名需要以该Enum类型名称开头

例子:

typedef NS_ENUM(NSInteger, AFNetworkReachabilityStatus) {

AFNetworkReachabilityStatusUnknown = -1,

AFNetworkReachabilityStatusNotReachable = 0,

AFNetworkReachabilityStatusReachableViaWWAN = 1,

AFNetworkReachabilityStatusReachableViaWiFi = 2

};

4、类的成员变量

* 小驼峰式命名:第一个单词以小写字母开始,后面的单词的首字母全部大写

* 以 _ 开头,第一个单词首字母小写

          例子:NSString * _somePrivateVariable

* 私有变量放在 .m 文件中声明

5、属性

* 小驼峰式命名

例子:@property (nonatomic, copy) NSString *userName;

UILabel  *userNameLabel;

UIButton *userNameButton;

UIImageView *userNameImageView

UIView *userNameView;

6、方法

* 方法名和方法参数遵循相同的规则,使用小写开头的小驼峰法;

* 方法名和参数尽量读起来像是一句话;

* 方法名不允许使用“get“前缀;

* -或+与返回类型间留一个空格,但参数列表之间不要留间隔;

* 如果参数过多,推荐每个参数各占一行;

例如:- (void)doSomethingWithString:(NSString *)theString (NSInteger *)theInteger {   ...   }  ;

书写规范:

1.方法大括号和其他大括号(if/else/switch/while 等.)总是在同一行语句打开但在新行中关闭。

2. 在m文件中对当前类属性进行引用的时候,使用self.property的方式,用以区分局部变量;对属性进行赋值的时候使用“点”赋值,即A.property = value;

3. 使用import引用头文件的工作全部放到 .m 文件中进行,.h文件用到的类型尽量用@class声明,然后在.m里import;

4. 如果m文件中有较多的method,使用 #pragma mark 标记对方法进行分组,便于查看;

在函数分组和protocol/delegate实现中使用#pragma mark -来分类方法,要遵循以下一般结构:

#pragma mark - Lifecycle

- (instancetype)init {}

- (void)dealloc {}

- (void)viewDidLoad {}

- (void)viewWillAppear:(BOOL)animated {}

- (void)didReceiveMemoryWarning {}

#pragma mark - Custom Accessors

- (void)setCustomProperty:(id)value {}

- (id)customProperty {}

#pragma mark - IBActions

- (IBAction)submitData:(id)sender {}

#pragma mark - Public

- (void)publicMethod {}

#pragma mark - Private

- (void)privateMethod {}

#pragma mark - Protocol conformance

#pragma mark - UITextFieldDelegate

#pragma mark - UITableViewDataSource

#pragma mark - UITableViewDelegate

#pragma mark - NSCopying

- (id)copyWithZone:(NSZone *)zone {}

#pragma mark - NSObject

- (NSString *)description {}

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 159,458评论 4 363
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 67,454评论 1 294
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 109,171评论 0 243
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 44,062评论 0 207
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 52,440评论 3 287
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 40,661评论 1 219
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 31,906评论 2 313
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 30,609评论 0 200
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 34,379评论 1 246
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 30,600评论 2 246
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 32,085评论 1 261
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 28,409评论 2 254
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 33,072评论 3 237
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 26,088评论 0 8
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 26,860评论 0 195
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 35,704评论 2 276
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 35,608评论 2 270

推荐阅读更多精彩内容

  • 一、命名规范 1、统一要求含义清楚,尽量做到不需要注释也能了解其作用,若做不到,就加注释,使用全称,不使用缩写。 ...
    Untils阅读 492评论 0 0
  • iOS编程规范0规范 0.1前言 为􏰀高产品代码质量,指导广大软件开发人员编写出简洁、可维护、可靠、可 测试、高效...
    iOS行者阅读 4,378评论 21 35
  • 1. 关于命名 1>要求含义清楚,尽量做到不需要注释也能了解其作用,若做不到,就加注释 2>类的命名 1.大驼峰式...
    herui201211阅读 149评论 0 0
  • 昨天去爺爺那裡吃了團圓飯,下午又去媽媽那裡坐了坐,晚上回到家,公公婆婆燒好了年夜飯等著我們。因為平日裡晚上就吃得很...
    如心1976阅读 175评论 0 0
  • Linux中大部分时间都是在处理文本内容,而为了更加快速和自动化的处理文本,我们就需要正则表达式。正则表达式提供了...
    shenzhenboy阅读 703评论 1 1