1. 关于命名

1.1 统一要求

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

  • 使用全称,不适用缩写

1.2 类的命名

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

              

例子:MFHomePageViewController
  • 后缀要求

a.ViewController: 使用ViewController做后缀

 例子: MFHomeViewController

b.View: 使用View做后缀

例子: MFAlertView

c.UITableCell:使用Cell做后缀

  例子: MFNewsCell

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

  例子: UITableViewDelegate

1.3 私有变量

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

  例子:firstName、lastName
  • 以 _ 开头,第一个单词首字母小写

  例子:NSString * _somePrivateVariable
  • 私有变量放在 .m 文件中声明

1.4 property变量

  • 小驼峰式命名

例子:///注释
@property (nonatomic, copy) NSString *userName;
  • 禁止使用synthesize关键词

1.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]]

1.6 Enum

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

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

 例子:
typedef NS_ENUM(NSInteger, AFNetworkReachabilityStatus) {
AFNetworkReachabilityStatusUnknown = -,
AFNetworkReachabilityStatusNotReachable = ,
AFNetworkReachabilityStatusReachableViaWWAN = ,
AFNetworkReachabilityStatusReachableViaWiFi =
};

1.7 Delegate命名

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

  例子:-(NSInteger)tableView:(UITableView*)tableView numberOfRowsInSection:(NSInteger)section
  • 回调方法的参数只有类自己的情况,方法名要符合实际含义

例子:
-(NSInteger)numberOfSectionsInTableView:(UITableView*)tableView
  • 以类的名字开头(回调方法存在两个以上参数的情况)以表明此方法是属于哪个类的

  例子:-(UITableViewCell*)tableView:(UITableView*)tableView cellForRowAtIndexPath:(NSIndexPath *)indexPath
  • 使用did和will通知Delegate已经发生的变化或将要发生的变化,

例子:
a.-(NSIndexPath*)tableView:(UITableView*)tableView willSelectRowAtIndexPath:(NSIndexPath*)indexPath; b.-(void)tableView:(UITableView*)tableView didSelectRowAtIndexPath:(NSIndexPath*)indexPath;

2. 私有方法及变量声明

2.1 声明位置

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

例子:
#import "CodeStandardViewController.h"
// 在这个category(类目)中定义变量和方法
@interface CodeStandardViewController (){
// 声明私有变量
} // 私有方法
- (void)samplePrivateMethod;
@end @implementation CodeStandardViewController // 私有方法的实现
- (void)samplePrivateMethod
{
//some code
}

3.关于注释

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

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

注释需要与代码同步更新

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

3.1 属性注释

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

3.2 方法声明注释

/**
* @brief 登录验证
*
* @param personId 用户名
* @param password 密码
* @param complete 执行完毕的block
*
* @return
*/
+ (void)loginWithPersonId:(NSString *)personId password:(NSString *)password complete:(void (^)(CheckLogon *result))complete;

4.关于UI布局

使用Interface Builder进行界面布局

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

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

5.格式化代码

5.1 指针 "*" 位置

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

  例子: NSString *userName;

5.2 方法的声明和定义

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

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

5.3 代码缩进

  • 使用 xcode 默认缩进,即 tab = 4空格

  • 使用 xcode 中 re-indent 功能定期对代码格式进行整理

  • 相同类型变量声明需要独行声明

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

例子:
#pragma mark - private methods
- (void)samplePrivateMethod
{...} - (void)sampleForIf
{...}

5.4 对method进行分组

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

例子:
#pragma mark - private methods
- (void)samplePrivateMethod
{...} - (void)sampleForIf
{...} - (void)sampleForWhile
{...} - (void)sampleForSwitch
{...} - (void)wrongExamples
{...} #pragma mark - public methods
- (void)samplePublicMethodWithParam:(NSString*)sampleParam
{...} #pragma mark - life cycle methods
- (id)initWithNibName:(NSString *)nibNameOrNil bundle:(NSBundle *)nibBundleOrNil
{...} - (void)viewDidLoad
{...} - (BOOL)shouldAutorotateToInterfaceOrientation:(UIInterfaceOrientation)interfaceOrientation
{...}

5.5 大括号写法

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

 例子:
- (id)initWithNibName:(NSString *)nibNameOrNilbundle:(NSBundle *)nibBundleOrNil
{
self = [super initWithNibName:nibNameOrNil
bundle:nibBundleOrNil];
if (self) {
// Custom initialization
} return self;
}
  • 对于其他使用场景: 左括号跟在第一行后边

 例子:
- (void)sampleForIf
{
BOOL someCondition = YES;
if(someCondition) {
// do something here
}
} - (void)sampleForWhile
{
int i = ;
while (i < ) {
// do something here
i = i + ;
}
} - (void)sampleForSwitch
{
SampleEnum testEnum = SampleEnumTwo;
switch(testEnum) {
caseSampleEnumUndefined:{
// do something
break;
}
caseSampleEnumOne:{
// do something
break;
}
caseSampleEnumTwo:{
// do something
break;
}
default:{
NSLog(@"WARNING: there is an enum type not handled properly!");
break;
}
}
  • 任何需要写大括号的部分,不得省略

错误示例:
- (void)wrongExamples
{
BOOLsomeCondition = YES;
if (someCondition)
NSLog(@"this is wrong!!!");
while(someCondition)
NSLog(@"this is wrong!!!");
}

iOS - 开发代码部分规范的更多相关文章

  1. IOS开发-代码规范

    代码风格的重要性对于一个团队和项目来说不言而喻.网上有许多 Objective-C 的代码风格,但这份简洁而又最符合苹果的规范,同时有助于养成良好的代码习惯,也是我们团队一直遵循的代码风格. 写法没有 ...

  2. iOS开发代码规范(通用)

    1. 关于命名 1> 统一要求 含义清楚,尽量做到不需要注释也能了解其作用,若做不到,就加注释 使用全称,不适用缩写 2> 类的命名 大驼峰式命名:每个单词的首字母都采用大写字母 例子:M ...

  3. iOS开发代码规范

    1.关于命名 1.1统一要求 含义清楚, 尽量做到不需要注释也能了解其作用,若做不到,就加注释 使用全称不使用缩写 1.2类的命名 大驼峰式命名:每一个单词的首字母都采用大写字母例子: MFHomeP ...

  4. iOS开发 代码 或 <Home+Power>截屏

      1. 截屏的两种简单方法, 注意这两种截图方法,都必须在视图完全加载完成后才能截图,即在 viewDidAppear 方法之后截屏,否则无法得到想要的截屏效果 (1) 利用绘图方法 renderI ...

  5. IOS开发代码分享之获取启动画面图片的string

    http://www.jb51.net/article/55309.htm 本代码支持 iPhone 6 以下. 支持 iPhone 及 iPad ? 1 2 3 4 5 6 7 8 9 10 11 ...

  6. iOS开发- Xcode插件- 规范凝视生成器VVDocumenter 自己的见解

    xcode升级  VVDocumenter 插件失效怎么办?? 首先给个完整的安装參考:http://www.th7.cn/Program/IOS/201405/212030.shtml  參考这个能 ...

  7. [IOS 开发代码]UIImage+Blur 网络图片模糊用法

    UIImage-Helpers 网络图片模糊用法   float quality = .00001f;    float blurred = .5f; NSURL *url = [NSURL URLW ...

  8. iOS开发_统计xcode代码行数

    如果要统计ios开发代码,包括头文件的,终端命令进入项目目录下,命令如下 find . -name "*.m" -or -name "*.h" -or -nam ...

  9. IOS开发 统计XCODE 代码行数

    如果要统计ios开发代码,包括头文件的,终端命令进入项目目录下,命令如下 find . -name "*.m" -or -name "*.h" -or -nam ...

随机推荐

  1. 消息中间件的意义和应用场景 (activeMq)

    消息中间件一般两个功能,解耦和异步处理,分别举个例子吧 解耦合:比如我们做一个微博产品中的好友系统,就很需要使用消息中间件当我们添加一个关注的时候, 涉及以下几个子系统 推荐系统,需要根据你关注的人给 ...

  2. python使用类作为装饰器

    1.普通就是一个函数作为装饰器,也可以用类名作为装饰器. 因为类和函数都是callable的,都可以使用括号来调用运行他. 2.上上篇的缓存一段时间的还是函数作为装饰器,类只是充当了比模块更下一级的命 ...

  3. Struts2_day04讲义_使用Struts2完成用户登录的权限拦截器的代码编写

  4. 第四章 TCP粘包/拆包问题的解决之道---4.1---

    4.1 TCP粘包/拆包 TCP是一个“流”协议,所谓流,就是没有界限的一串数据.TCP底层并不了解上层业务数据的具体含义,它会根据TCP缓冲区的实际情况进行包的划分,所以在业务上认为,一个完整的包可 ...

  5. python读取文件embedded null character是什么原因

    地址的\需要转义符: 将\写成\\ 或者在整个字符串前面添加字母r

  6. python中交换两个值的方法

    a = 4b = 5 #第1种c = 0c = aa = bb = c #第2种a = a+bb = a-ba = a-b #第3种a,b = b,a 第三种办法本质上是元组之间的赋值 print(& ...

  7. 执行RF测试只生成output.xml文件,不生成log和report文件

    命令格式: -l --log file HTML log file. Can be disabled by giving a special value `NONE`. Default: log.ht ...

  8. NFS exportfs 命令

    exportfs 是在服务端上使用的命令,主要用来操作挂载的目录,比如我们修改了NFS配置文件,需要重启NFS服务,如果客户端正在读写,那么重启NFS服务对客户端是有影响的,因此 exportfs 命 ...

  9. CentoOS6.6安装netcat

    http://blog.csdn.net/u013673976/article/details/47084841 CentOS下安装netcat 使用zookeeper过程中,需要监控集群状态.在使用 ...

  10. 在wepy里面使用redux

    wepy 框架本身是支持 Redux 的,我们在构建项目的时候,将 是否安装 Redux 选择 y 就好了,会自动安装依赖,运行项目后看官方给的 demo 确实是可以做到的,但是官方文档里却对这一块只 ...