1. 关于命名
1.统一要求
含义清楚，尽量做到不需要注释也能了解其作用，若做不到，就加注释；使用全称，不使用缩写
2 类的命名
大驼峰式命名：每个单词的首字母都采用大写字母
例子：
TWHomePageViewController
后缀要求
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 320.0
小驼峰命名。[带参数]
#define getImageUrl(url) [NSURL URLWithString:[NSString stringWithFormat:@"%@%@",kBaseUrl,url]]
6 Enum
Enum类型的命名与类的命名规则一致
Enum中枚举内容的命名需要以该Enum类型名称开头
例子:
typedef NS_ENUM(NSInteger, AFNetworkReachabilityStatus) {
AFNetworkReachabilityStatusUnknown = -1,
AFNetworkReachabilityStatusNotReachable = 0,
AFNetworkReachabilityStatusReachableViaWWAN = 1,
AFNetworkReachabilityStatusReachableViaWiFi = 2
};
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进行声明
例子:
#import "CodeStandardViewController.h"
// 在这个category（类目）中定义变量和方法
@interface CodeStandardViewController ()
{
// 声明私有变量
}
// 私有方法
- (void)samplePrivateMethod;
@end
@implementation CodeStandardViewController
// 私有方法的实现
- (void)samplePrivateMethod{
//some code
}
3. 关于注释
尽管写的时候很痛苦，但是他们对于保持你代码的可读性来说绝对是至关重要的。下面几条规则描述了你应该什么时候在什么地方加注释。
但是要记住，虽然注释很重要，但是最好的代码都是自注释的。给变量和类型一个有意义的名字，要比用一个难懂的名字然后再费力的用注释来解释好得多。
写注释的时候，要写给你的读者：下一个要读懂你代码的贡献者。多写点吧——下个没准就是你自己！
注释需要与代码同步更新
1 File Comments文件注释
可以有选择的在一个文件开头写一段关于内容的描述。
2 属性注释
快捷键: 光标放在属性名前面 command+option+/
例子：
/**
学生
*/
@property (nonatomic, strong) Student *student;
3 方法声明注释Declaration Comments
快捷键: 光标放在方法名前面 command+option+/
每个接口，类别，协议的声明都应该有个伴随的注释，来描述他的作用以及他如何融入整体环境
/**
登录验证
@param personId 用户名
@param password 密码
@param complete 执行完毕的block
*/
+ (void)loginWithPersonId:(NSString *)personId password:(NSString *)password complete:(void (^)(CheckLogon *result))complete;
4 实现声明Implementation Comments
用竖向排列方式在注释中引用变量名和符号，不要写成一整行。
4. 关于UI布局
使用Interface Builder进行界面布局
Xib文件的命名与其对应的.h文件保持相同
Xib文件中控件的组织结构要合理，Xib文件中控件需要有合理的可读性强的命名，方便他人理解
5. 格式化代码
1 指针 "*" 位置
定义一个对象时，指针 "*" 靠近变量
//例子:
NSString *userName;
2 方法的声明和定义
在 "-" 、"+" 和 返回值之间留一个空格，方法名和第一个参数之间不留空格
“=”、“==”、“>=”、“<=”、“/”、“%”等符号前后需要均需有一个空格
“]” 后面如果跟的是方法名，需要有一个空格
- (id)initWithNibName:(NSString *)nibName nibBundle:(NSBundle *)nibBundle{}
3代码缩进
使用 xcode 默认缩进，即 tab = 4空格
使用 xcode 中 re-indent 功能定期对代码格式进行整理
相同类型变量声明需要独行声明
例子:
CGFloatOriginX = frame.origin.x;
CGFloatOriginY = frame.origin.y;
CGFloatlineWidth = frame.size.width;
Method与Method之间最多空一行，但要在一个项目里统一，要么都空一行，要么都不空行
例子:
#pragma mark - private methods
- (void)samplePrivateMethod{}
- (void)sampleForIf {}
复制代码
4 对method进行分组
使用 #pragma mark - 方式对类的方法进行分组
例子:
#pragma mark -
#pragma mark - private
- (void)samplePrivateMethod{}
- (void)sampleForIf{}
- (void)wrongExamples{}
#pragma mark -
#pragma mark - public methods
- (void)samplePublicMethodWithParam:(NSString*)sampleParam{}
#pragma mark -
#pragma mark - life cycle methods
- (id)initWithNibName:(NSString *)nibNameOrNil bundle:(NSBundle *)nibBundleOrNil{}
- (void)viewDidLoad{}
5 大括号写法
对于类的method: 左括号另起一行写(苹果官方文档)，但是我个人觉得左括号跟在第一行后边会更好，因为这样把代码折叠起来效果更好，可以看到的方法更多
例子：
- (id)initWithNibName:(NSString *)nibNameOrNilbundle:(NSBundle *)nibBundleOrNil{
self = [super initWithNibName:nibName OrNilbundle:nibBundleOrNil];
if (self) {
// Custom initialization
}
return self;
}
对于其他使用场景: 左括号跟在第一行后边
例子：
- (void)sampleForIf {
BOOL someCondition = YES;
if(someCondition) {
// do something here
}
}
- (void)sampleForWhile {
int i = 0;
while (i < 10) {
// do something here
i = i + 1;
}
}
- (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!!!");
}
6 代码宽度、函数的行数、类的行数
每行的宽度
应尽量在你的代码中将每行控制在80个字符内。
每个函数的行数
应尽量在你的代码中将每个函数的行数控制在100行内。
每个类的行数
应尽量在你的代码中将每个类的行数控制在1000行内。
尽量使用新的API
项目最低适配系统如果设置的是在iOS8以上
建议把UIActionSheet和UIAlertView统一升级为UIAlertController
建议把UIWebView升级为WKWebView
项目最低适配系统如果设置的是在iOS9以上
建议把AddressBook升级为Contacts
网友评论