文档章节

iOS开发代码规范(通用)

xiaobai1315
 xiaobai1315
发布于 2017/04/14 18:15
字数 1280
阅读 6
收藏 0

 

1. 关于命名

 1> 统一要求

  • 含义清楚,尽量做到不需要注释也能了解其作用,若做不到,就加注释

  • 使用全称,不适用缩写

 2> 类的命名

  • 大驼峰式命名:每个单词的首字母都采用大写字母

   例子:MFHomePageViewController

  • 后缀要求

  ViewController: 使用ViewController做后缀

       例子: MFHomeViewController

     View: 使用View做后缀

       例子: MFAlertView

     UITableCell:使用Cell做后缀

       例子: MFNewsCell

     Protocol: 使用Delegate或者DataSource作为后缀

       例子: UITableViewDelegate

     UI控件依次类推

 3> 私有变量

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

  例子:firstName、lastName

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

  例子:NSString * _somePrivateVariable

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

 4> property变量

  • 小驼峰式命名

   例子:///注释

      @property (nonatomic, copy) NSString *userName;

  • 禁止使用synthesize关键词

 5> 宏命名

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

  例子: #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]]

 6> Enum

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

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

  例子:

1 typedef NS_ENUM(NSInteger, AFNetworkReachabilityStatus) {
2     AFNetworkReachabilityStatusUnknown = -1,
3     AFNetworkReachabilityStatusNotReachable = 0,
4     AFNetworkReachabilityStatusReachableViaWWAN = 1,
5     AFNetworkReachabilityStatusReachableViaWiFi = 2
6     };

 7> Delegate命名

  • 类的实例必须为回调方法的参数之一, 如

  -(NSInteger)tableView:(UITableView*)tableView numberOfRowsInSection:(NSInteger)section

  • 回调方法的参数只有类自己的情况,方法名要符合实际含义, 如:

  -(NSInteger)numberOfSectionsInTableView:(UITableView*)tableView

  • 以类的名字开头(回调方法存在两个以上参数的情况)以表明此方法是属于哪个类的, 如:

  -(UITableViewCell*)tableView:(UITableView*)tableView cellForRowAtIndexPath:(NSIndexPath *)indexPath

  • 使用did和will通知Delegate已经发生的变化或将要发生的变化, 如:

  -(NSIndexPath*)tableView:(UITableView*)tableView willSelectRowAtIndexPath:(NSIndexPath*)indexPath;
  -(void)tableView:(UITableView*)tableView  didSelectRowAtIndexPath:(NSIndexPath*)indexPath;

2. 私有方法及变量声明

 1> 声明位置

  在.m文件中最上方,定义空的category进行声明
   例子:

复制代码

1        #import "CodeStandardViewController.h"
 2     // 在这个category(类目)中定义变量和方法
 3     @interface CodeStandardViewController ()
 4     {
 5 
 6       // 声明私有变量
 7     }
 8 
 9      // 私有方法
10     - (void)samplePrivateMethod;
11     @end
12 
13     @implementation CodeStandardViewController
14     // 私有方法的实现
15     - (void)samplePrivateMethod
16     {
17       //some code
18     }

复制代码

3. 关于注释

 最好的代码是不需要注释的 尽量通过合理的命名

 良好的代码把含义表达清楚 在必要的地方添加注释

 注释需要与代码同步更新

 如果做不到命名尽量的见名知意的话,就可以适当的添加一些注释或者mark

 1> 属性注释

  例子:
    /// 学生
    @property (nonatomic, strong) Student *student;

 2> 方法声明注释:

复制代码

1     /** 
 2    * @brief 登录验证
 3    *
 4    * @param personId 用户名
 5    * @param password 密码
 6    * @param complete 执行完毕的block
 7    *
 8    * @return
 9    */
10   + (void)loginWithPersonId:(NSString *)personId password:(NSString *)password complete:(void (^)(CheckLogon *result))complete;

复制代码

4. 关于UI布局

 使用Interface Builder进行界面布局

 Xib文件的命名与其对应的.h文件保持相同

 Xib文件中控件的组织结构要合理,Xib文件中控件需要有合理的可读性强的命名,方便他人理解

5. 格式化代码

 1> 指针 "*" 位置

  定义一个对象时,指针 "*" 靠近变量

   例子: NSString *userName;

 2> 方法的声明和定义

  在 - 、+ 和 返回值 之间留一个空格,方法名和第一个参数之间不留空格

- (id)initWithNibName:(NSString *)nibNameOrNilbundle:(NSBundle *)nibBundleOrNil
{...}

 3> 代码缩进

  • 使用 xcode 默认缩进,即 tab = 4空格
  • 使用 xcode 中 re-indent 功能定期对代码格式进行整理
  • 相同类型变量声明需要独行声明

  例子:

CGFloatoringX = frame.origin.x;
CGFloatoringY = frame.origin.y;
CGFloatlineWidth = frame.size.width;
  • Method与Method之间空一行

  例子:

复制代码

1 #pragma mark - private methods
2 
3 - (void)samplePrivateMethod
4 {...}
5 
6 - (void)sampleForIf
7 {...}

复制代码

 4> 对method进行分组

  使用 #pragma mark - 方式对类的方法进行分组

   例子:

复制代码

1      #pragma mark - private methods
 2 
 3   - (void)samplePrivateMethod
 4   {...}
 5 
 6   - (void)sampleForIf
 7   {...}
 8 
 9   - (void)sampleForWhile
10   {...}
11   
12   - (void)sampleForSwitch
13   {...}
14 
15   - (void)wrongExamples
16   {...}
17 
18   #pragma mark - public methods
19   - (void)samplePublicMethodWithParam:(NSString*)sampleParam
20   {...}
21 
22   #pragma mark - life cycle methods
23   - (id)initWithNibName:(NSString *)nibNameOrNil bundle:(NSBundle *)nibBundleOrNil
24   {...}
25 
26   - (void)viewDidLoad
27   {...}
28 
29   - (BOOL)shouldAutorotateToInterfaceOrientation:(UIInterfaceOrientation)interfaceOrientation
30   {...}

复制代码

 5> 大括号写法

  • 对于类的method: 左括号另起一行写(遵循苹果官方文档)

   例子:

复制代码

1      - (id)initWithNibName:(NSString *)nibNameOrNilbundle:(NSBundle *)nibBundleOrNil
 2   {
 3       self = [super initWithNibName:nibNameOrNil
 4 
 5       bundle:nibBundleOrNil];
 6 
 7       if (self) {
 8             // Custom initialization
 9         }
10 
11       return self;
12 }

复制代码

  • 对于其他使用场景: 左括号跟在第一行后边

  例子:

复制代码

1 - (void)sampleForIf
 2 {
 3     BOOL someCondition = YES;
 4     if(someCondition) {
 5         // do something here
 6     }
 7 }
 8 - (void)sampleForWhile
 9 {
10     int i = 0;
11     while (i < 10) {
12         // do something here
13         i = i + 1;
14     }
15 }
16 - (void)sampleForSwitch
17 {
18     SampleEnum testEnum = SampleEnumTwo;
19     switch(testEnum) {
20         caseSampleEnumUndefined:{
21             // do something
22             break;
23         }
24         caseSampleEnumOne:{
25             // do something
26             break;
27         }
28         caseSampleEnumTwo:{
29             // do something
30             break;
31         }
32         default:{
33             NSLog(@"WARNING: there is an enum type not handled properly!");
34             break;
35         }
36     }

复制代码

  • 任何需要写大括号的部分,不得省略

  错误示例:

复制代码

1 - (void)wrongExamples
2 {
3     BOOLsomeCondition = YES;
4     if (someCondition)
5         NSLog(@"this is wrong!!!");
6     while(someCondition)
7         NSLog(@"this is wrong!!!");
8 }

复制代码

 

本文转载自:http://www.cnblogs.com/gfxxbk/p/5469017.html

xiaobai1315
粉丝 4
博文 222
码字总数 77470
作品 0
程序员
私信 提问
fir.im Weekly - 每个程序员都应当拥有的技能树

本周收集了一些优秀的 iOS & Android 开发资源和程序员 IT 技能拓展的 Tips. 知道创宇研发技能表 v3.0 作为程序员可能都听说过【知道创宇】,他们是一家黑客文化浓厚的安全公司。这张技能表为...

风起云飞fir_im
2015/09/06
44
0
谷歌Flutter跨平台应用开发SDK迎来首个发行预览版本

谷歌Flutter跨平台应用开发SDK迎来首个发行预览版本 2018-06-22 12:26编辑: 枣泥布丁分类:程序人生来源:程序师 跨平台Google Flutter预览版本 招聘信息: 图像处理及模式识别工程师 C/C+...

枣泥布丁
2018/06/22
0
0
现代传播集团招募iOS高级工程师

现代传播集团招募 高级iOS开发工程师 工作地点:北京 三里屯 薪水:10k-20k 简历请发到 linyize@modernmedia.com.cn 岗位职责: 1. 负责现代传播集团 iphone/ipad 客户端应用软件开发与维护;...

linyize
2013/05/07
311
0
【AR】开始使用Vuforia开发iOS(2)

原 设置iOS开发环境 安装Vuforia iOS SDK 如何安装Vuforia iOS示例 编译并运行Vuforia iOS示例 支持iOS金属 iOS 64位迁移 设置iOS开发环境 适用于iOS的Vuforia引擎目前支持运行iOS 9及更高版...

lichong951
2018/06/11
0
0
iOS三维菜单、调试工具、封装通讯录、网络框架、多种控件和动画等源码

iOS精选源码 一个调用系统通讯录和获取通讯录所有联系人的封装(http://www.code4app.com/thread-29726-1-1.html) ios scrollview嵌套tableview同向滑动(初级、进阶), 支持OC / Swift(http...

sunnyaigd
2018/05/15
55
0

没有更多内容

加载失败,请刷新页面

加载更多

Spring Boot + Mybatis-Plus 集成与使用(二)

前言: 本章节介绍MyBatis-Puls的CRUD使用。在开始之前,先简单讲解下上章节关于Spring Boot是如何自动配置MyBatis-Plus。 一、自动配置 当Spring Boot应用从主方法main()启动后,首先加载S...

伴学编程
昨天
7
0
用最通俗的方法讲spring [一] ──── AOP

@[TOC](用最通俗的方法讲spring [一] ──── AOP) 写这个系列的目的(可以跳过不看) 自己写这个系列的目的,是因为自己是个比较笨的人,我曾一度怀疑自己的智商不适合干编程这个行业.因为在我...

小贼贼子
昨天
7
0
Flutter系列之在 macOS 上安装和配置 Flutter 开发环境

本文为Flutter开发环境在macOS下安装全过程: 一、系统配置要求 想要安装并运行 Flutter,你的开发环境需要最低满足以下要求: 操作系统:macOS(64位) 磁盘空间:700 MB(不包含 IDE 或其余...

過愙
昨天
6
0
OSChina 周六乱弹 —— 早上儿子问我他是怎么来的

Osc乱弹歌单(2019)请戳(这里) 【今日歌曲】 @凉小生 :#今日歌曲推荐# 少点戾气,愿你和这个世界温柔以待。中岛美嘉的单曲《僕が死のうと思ったのは (曾经我也想过一了百了)》 《僕が死の...

小小编辑
昨天
2.7K
16
Excption与Error包结构,OOM 你遇到过哪些情况,SOF 你遇到过哪些情况

Throwable 是 Java 中所有错误与异常的超类,Throwable 包含两个子类,Error 与 Exception 。用于指示发生了异常情况。 Java 抛出的 Throwable 可以分成三种类型。 被检查异常(checked Exc...

Garphy
昨天
42
0

没有更多内容

加载失败,请刷新页面

加载更多

返回顶部
顶部