iOS开发代码规范
1、关于命名
1.1统一要求
- 含义清楚, 尽量做到不需要注释也能了解其作用,若做不到,就加注释
- 使用全称不使用缩写
1.2类的命名
- 大驼峰式命名:每一个单词的首字母都采用大写字母
例子: MFHomePageViewController - 后缀要求
- ViewController: 使用ViewController做后缀
例子: MFHomeViewController - View: 使用View做后缀
例子: MFAlertView - UITableCell:使用Cell做后缀
例子: MFNewsCell - Protocol: 使用Delegate或者DataSource作为后缀
例子: UITableViewDelegate - UI控件以此类推
- ViewController: 使用ViewController做后缀
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” - 驼峰命名。[带参数]
#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已经发生的变化或将要发生的变化, 如:
-(NSIndexPath*)tableView:(UITableView*)tableView willSelectRowAtIndexPath:(NSIndexPath *)indexPath;
-(void)tableView:(UITableView*)tableView didSelectRowAtIndexPath:(NSIndexPath *)indexPath;
2、私有方法及变量声明
2.1声明位置
在.m文件中最上方,定义空的category进行声明
例子:
#import "CodeStandardViewController.h"
//define your private variables and methods here
@interface CodeStandardViewController ()
{
}
- (void)samplePrivateMethod;
@end #define THIS_IS_AN_SAMPLE_MACRO @"THIS_IS_AN_SAMPLE_MACRO"
@implementation CodeStandardViewController
#pragma mark - private methods
- (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、格式化代码
4.1指针 "*" 位置
例子: NSString *userName;
4.2方法的声明和定义
在 - 、+ 和返回值之间留一个空格,方法名和第一个参数之间不留空格
- (id)initWithNibName:(NSString *)nibNameOrNil bundle:(NSBundle *)nibBundleOrNil {
...
}
4.3代码缩进
- 使用xcode默认缩进,即 tab = 4空格
- 使用xcode中re-indent功能定期对代码格式进行整理
- 相同类型变量声明需要独行声明
例子:CGFloat oringX = frame.origin.x;
CGFloat oringY = frame.origin.y;
CGFloat lineWidth = frame.size.width; - Method与Method之间空一行
例子:#pragma mark - private methods
- (void)samplePrivateMethod{
...
}
- (void)sampleForIf{
...
}
4.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{
...
}
4.5大括号写法
- 对于类的method: 左括号另起一行写
例子:
- (id)initWithNibName:(NSString *)nibNameOrNil bundle:(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) {
case SampleEnumUndefined:{
// do something
break;
}
case SampleEnumOne:{
// do something
break;
}
case SampleEnumTwo:{
// do something
break;
}
default:{
NSLog(@"WARNING: there is an enum type not handled properly!");
break;
}
} - 任何需要写大括号的部分,不得省略
iOS开发代码规范的更多相关文章
- IOS开发-代码规范
代码风格的重要性对于一个团队和项目来说不言而喻.网上有许多 Objective-C 的代码风格,但这份简洁而又最符合苹果的规范,同时有助于养成良好的代码习惯,也是我们团队一直遵循的代码风格. 写法没有 ...
- iOS开发代码规范(通用)
1. 关于命名 1> 统一要求 含义清楚,尽量做到不需要注释也能了解其作用,若做不到,就加注释 使用全称,不适用缩写 2> 类的命名 大驼峰式命名:每个单词的首字母都采用大写字母 例子:M ...
- Android开发代码规范(转)
Android开发代码规范 1.命名基本原则 在面向对象编程中,对于类,对象,方法,变量等方面的命名是非常有技巧的.比如,大小写的区分,使用不同字母开头等等.但究其本,追其源,在为一个资源其名称 ...
- web前端开发 代码规范 及注意事项
web前端开发 代码规范 及注意事项 外部命名规范 html .js .css文件名称命名规范 my_script.js my_camel_case_name.css my_index.html 路径 ...
- iOS团队代码规范
iOS团队代码规范 工程之始可能需要的工具: 1.使用CocoaPods类库管理工具.CocoaPods安装和使用教程. 2.下载安装注释插件VVDocumenter-Xcode. 一.项目结构管理 ...
- FW开发代码规范---小任性(2)
三.空行 (1)在每个函数.结构体.枚举定义结束之后都要加空行. 在一个函数体内,逻辑密切相关的语句之间不加空行,其它地方应加空行分隔. struct st1 { - }; // 空行 enum { ...
- Web 前端开发代码规范(基础)
一. 引言 对于一个多人团队来说,制定一个统一的规范是必要的,因为个性化的东西无法产生良好的聚合效果,规范化可以提高编码工作效率,使代码保持统一的风格,以便于代码整合和后期维护. 二. HTML/CS ...
- iOS OC开发代码规范
1.变量.类名.函数名 使用驼峰命名法 2.尽量使用完整的单词命名,尽量不采用 缩写单词 3.类名使用大写字母打头,前缀统一加上HH 例如:HHHomePageController 4.类的成员变量使 ...
- iOS - 开发代码部分规范
1. 关于命名 1.1 统一要求 含义清楚,尽量做到不需要注释也能了解其作用,若做不到,就加注释 使用全称,不适用缩写 1.2 类的命名 大驼峰式命名:每个单词的首字母都采用大写字母 例子:MFHom ...
随机推荐
- bzoj1312
忘写题解了,经典的最大密度子图 可以类似分数规划的做,二分密度,然后转化为最大权闭合子图做,判断是否大于0 注意方案的输出 const eps=1e-6; lim=1e-12; inf=; type ...
- SyntaxHighlighter -- 代码高亮插件
SyntaxHighlighter 下载文件里面支持皮肤匹配. 地址:http://alexgorbatchev.com/SyntaxHighlighter/
- rtp h264注意点(FU-A分包方式说明)
前写过一篇文章,分析了h264使用rtp进行封包的格式介绍:RTP封装h264.但里面好像没有把拆分以及一些需要注意的情况说清楚,因此这里做补充,也作为自己的备忘(自己记性好像不太好). 关于时间戳, ...
- Oracle中获取执行计划的几种方法分析
以下是对Oracle中获取执行计划的几种方法进行了详细的分析介绍,需要的朋友可以参考下 1. 预估执行计划 - Explain PlanExplain plan以SQL语句作为输入,得到这条S ...
- Oracle 课程八之性能优化之Oracle SQL Trace
一. SQL_TRACE 当SQL语句出现性能问题时,我们可以用SQL_TRACE来跟踪SQL的执行情况,通过跟踪,我们可以了解一条SQL或者PL/SQL包的运行情况,SQL_TRACE命令会将SQL ...
- hdu 4057(ac自动机+状态压缩dp)
题意:容易理解... 分析:题目中给的模式串的个数最多为10个,于是想到用状态压缩dp来做,它的状态范围为1-2^9,所以最大为2^10-1,那我们可以用:dp[i][j][k]表示长度为i,在tri ...
- Unable to execute dex: method ID not in [0, 0xffff]: 65536
http://ingramchen.io/blog/2014/09/prevention-of-android-dex-64k-method-size-limit.html
- 《Python 学习手册4th》 第十二章 if测试和语法规则
''' 时间: 9月5日 - 9月30日 要求: 1. 书本内容总结归纳,整理在博客园笔记上传 2. 完成所有课后习题 注:“#” 后加的是备注内容 (每天看42页内容,可以保证月底看完此书) “重点 ...
- SQL你必须知道的-增删改查与约束
SQL你必须知道的-增删改查与约束 -- 插入数据 --Insert 语句可以省略表名后的列名,但是不推荐 insert into Class values ('' 高一一班 '', ...
- cocos2d-x 详解之 CCTexture2D(纹理图片)和 CCTextureCache(纹理缓存)
精灵和动画都涉及到纹理图片的使用,所以在研究精灵与动画之前,我们先来了解一下纹理图片类CCTexture2D和纹理缓存CCTextureCache的原理: 当一张图片被加载到内存后,它是以纹理的形式存 ...