一:命名
统一要求:
1.含义清楚,不用看注释也能了解其作用,若做不到则加注释。
2.使用全称,若简写则使用通用简写。eg:btn
3.不允许出现中文。
1.类的命名
大驼峰式命名:每个单词的首字母大写。
eg:
UIViewController
2.变量命名
小驼峰式命名:第一个单词首字母小写,后面的每个单词的首字母大写。
eg:
userName
3.宏命名
以字母k开头,后面遵循大驼峰命名。
eg:
#define kWidth self.frame.size.width
4.Enum命名
1.Enum类型的命名与类的命名规则一致。
2.Enum中枚举内容的命名需要以该Enum类型名称开头。
eg:
1 typedef NS_ENUM(NSInteger, AFNetworkReachabilityStatus) {
2 AFNetworkReachabilityStatusUnknown = -1,
3 AFNetworkReachabilityStatusNotReachable = 0,
4 AFNetworkReachabilityStatusReachableViaWWAN = 1,
5 AFNetworkReachabilityStatusReachableViaWiFi = 2
6 };
5.函数的命名
小驼峰式命名。
eg:
- (void)viewDidLoad {
}
6.资源文件命名
1.根据该资源的使用场景,做对应的命名,使用英文命名。
2.针对图片资源,使用对应的英文命名,一般情况下只保留2x的图片即可。
eg:
fh_app_logo@2x.png
fh_session_mute@2x.png
二:格式
统一要求:
1.属性与函数之间空一行。
2.函数与函数之间空一行。
3.任何需要写大括号的部分,不得省略。
eg
#import <UIKit/UIKit.h>
@interface ViewController : UIViewController
@property (nonatomic, copy) NSString *userName;
- (void)saveUserInfo;
@end
- (void)viewDidLoad {
[super viewDidLoad];
}
- (void)saveUserInfo {
}
1.函数的格式
左花括号距函数名后空一格,右花括号在函数结尾另起一行。
eg:
- (void)viewDidLoad {
[super viewDidLoad];
self.view.backgroundColor = [UIColor greenColor];
}
2.条件语句格式
1.代码之间有空格,并遵守函数的格式,条件语句的判断变量在左,常量在右。
eg:
if (0 == index) {
NSLog(@"index = 0");
} else {
NSLog(@"index != 0");
}
2.条件过多,过长的时候应该换行。
eg:
if (condition1() &&
condition2() &&
condition3() &&
condition4()) {
// Do something
}
三:UI布局
1.使用Interface Builder进行界面布局。
2.Xib文件的命名与其对应的.h文件保持相同。
3.Xib文件中控件的组织结构要合理,Xib文件中控件需要可读性强的命名,方便他人理解。
网友评论