iOS项目编码规范（二）布局
2016-04-27 本文已影响56人
Abekkkkk
文件布局
1.头文件.h
文件引用 (依次为标准头文件、非标准头文件) // import <>
类引用（按类功能写，view、model、help）// import ""
宏定义 // define
枚举定义 // typdef NS_ENUM() & type NS_OPTIONS()
常量定义 // extern NSString *const ConstName
类声明 // @class ClassName;
block声明（根据是否需要类声明，放在类声明前后）
//typedef returnType(^name)(arguments);
协议声明 // @protocol ProtocolName;
类定义 // @interface ...
协议定义 // @protocol ...
简图
/**********************************************************************
* 文件引用
**********************************************************************/
/**********************************************************************
* 类引用
**********************************************************************/
/**********************************************************************
* 宏定义
**********************************************************************/
/**********************************************************************
* 枚举定义
**********************************************************************/
/**********************************************************************
* 常量定义
**********************************************************************/
/**********************************************************************
* 类声明
**********************************************************************/
/**********************************************************************
* block声明（根据是否需要类声明，放在类声明前后）
**********************************************************************/
/**********************************************************************
* 协议声明
**********************************************************************/
/**********************************************************************
* 类定义
**********************************************************************/
/**********************************************************************
* 协议定义
**********************************************************************/
举个栗子：
#import <Foundation/Foundation.h>
#import <UIKit/UIKit.h>
#import "ViewA.h"
#import "ViewB.h"
#import "ModelA.h"
#import "ModelB.h"
#import "Help.h"
#import "Class+CategoryName.h"
#define FUNC(a) func(a)
#define MACRO_NAME realName
/*枚举定义*/
typedef NS_ENUM(NSUInteger, AFSSLPinningMode) {
AFSSLPinningModeNone,
AFSSLPinningModePublicKey,
AFSSLPinningModeCertificate,
};
/*常量定义*/
extern NSString * const CSToastPositionTop;
extern CGFloat const kJSAvatarImageSize;
/*block声明*/
typedef void(^SDWebImageCheckCacheCompletionBlock)(BOOL isInCache);
/*类声明*/
@class ModelC; // 注意1
/*协议声明*/
@protocol ClassAbcDelegate
/*类定义*/
@interface ClassAbc : NSObject
/*属性声明*/
@property (nonatomic, copy) NSString *stringA;
@property (nonatomic, copy) SDWebImageCheckCacheCompletionBlock *blockA;
/*初始化方法 注意3*/
+ (instancetype)sharedInstance; // 单例类方法
- (instancetype)initWithA:(ClassA *)aObjectA;
/*公开方法 注意4*/
- (void)funcA;
- (void)doSomeWithB:(ClassB *)aB C:(ClassC *)aC;
@end
/*协议定义*/
@protocol ClassAbcDelegate <NSObject>
@request
- (void)classAbc:(ClassAbc *)aAbc doSomethingWithIndex:(NSInteger)index;
@option
- (void)doSomethingWithClassAbc:(ClassAbc *)aAbc;
- (void)keyboardWillBeDismissed;
@end
注意1：引用应该尽量放在.m文件中，.h中尽量用类声明@class
注意2：常量中的const不同位置代表不同含义 点击这里
注意3：初始化方法中，返回值使用instancetype关键字 点击这里
注意4：头文件中声明的方法是可以被外界调用的，不需要外界调用的方法不要在头文件声明
2.类文件.m
文件引用 (依次为标准头文件、非标准头文件) // import <>
类引用（按类功能写，view、model、help）// import ""
宏定义 // define
常量定义 //NSString * const ConstName & 本地静态常量 static const
本地变量（静态全局变量） // static BOOL right;
interface-extension // 放私有属性,也可以在{}之间放私有(成员)变量
类的实现 // @implementation ClassAbc ... @end
简图
/**********************************************************************
* 文件引用
**********************************************************************/
/**********************************************************************
* 类引用
**********************************************************************/
/**********************************************************************
* 宏定义
**********************************************************************/
/**********************************************************************
* 常量定义
**********************************************************************/
/**********************************************************************
* 本地变量（静态全局变量）
**********************************************************************/
/**********************************************************************
* interface-extension 类特性
* 私有属性声明
**********************************************************************/
/**********************************************************************
* 类的实现
* 各种方法
**********************************************************************/
举个例子
#import "ClassAbc.h"
#import <objc/runtime.h>
#import "ViewA.h"
#import "ModelA.h"
#import "Help.h"
#import "Class+CategoryName.h"
/*宏定义*/
#define UM_TIME_LIMIT 1
/*常量定义*/
NSString * const UAProgressViewProgressAnimationKey = @"UAProgressViewProgressAnimationKey";
static NSUInteger const kUsernameRow = 0;
static NSString * const CSToastTimerKey = @"CSToastTimerKey";
/*本地变量（静态全局变量）*/
static BOOL showFinishButton;
/*interface-extension 类特性*/
@interface ClassAbc () <Class1Delegate, Class2Delegate>
/*私有属性声明*/
@property (nonatomic, copy) UIScrollView *contentScroll;
@end
/*类的实现*/
@implementation ClassAbc
// 各种方法
@end
2.1.使用#pragma mark - 来分类方法
#pragma mark – Life Cycle
#pragma mark - UITextFieldDelegate
#pragma mark - UITableViewDataSource
#pragma mark - UITableViewDelegate
#pragma mark - Custom Delegates
#pragma mark - Events // (依次notification Event；Control Event；KVO Event)
/*
#pragma mark - Notifications
#pragma mark - Events Response
#pragma mark - KVO (或者写Key-value observing)
*/
#pragma mark – Public Methods // .h里面声明，可以被别的类使用的方法
#pragma mark – Private Methods // controller无关的私有方法，抽离到category或viewModel、helper、storge中去
#pragma mark – Getters // 一般用getter来做属性的初始化
#pragma mark – Setters // 没有实现上的需求，不使用setter做初始化
注意1：遵守方法函数单一功能原则
注意2：Life Cycle中，除了Overriding的方法之外，也应包含与之密不可分的私有方法。
注意3：每个方法、模块之间，只需要空一行就足够了
参考文章：
《iOS架构之路：IOS项目中的编码规范》
