目錄
編碼規(guī)范
Chinamobo 編碼規(guī)范
補(bǔ)充代碼規(guī)范
注釋
///性別
@property (nonatomic, copy) NSString *sex
/**
* 函數(shù)功能
*
* @param time 當(dāng)前時間
*/
- (void)function:(NSString *)time;
在XXXViewController.m中建議加上這樣的注釋灌灾,讓別人查看代碼時可以一目了然:
#pragma mark - life cycle
#pragma mark - overwrite
#pragma mark - public
#pragma mark - delegate
#pragma mark -- XXX
#pragma mark - notification
#pragma mark -- XXX
#pragma mark - event response
#pragma mark - private
#pragma mark - getter and setter
前綴
給ViewController起名字時統(tǒng)一加上前綴音婶,一般為工程名的首字母簡寫葫男。如工程名為一賬通
掰吕,前綴則為YZT
思恐。
給ViewController中的私有方法起名時唁桩,加上前綴yzt_
#pragma mark - private
- (void)yzt_privateFunction // 私有方法前加yzt_
{
}
引入其他文件
頭文件中:
//頭文件能用@class就不要import
實(shí)現(xiàn)文件:
// 頭文件
#import " YSYGuidelines.h"
// 系統(tǒng)文件
#import <objc/runtime.h>
#import <UIKit/UIKit.h>
// 其他自定義文件
類中屬性定義
@interface YSYGuidelines : NSObject
{
NSString *_name //不要出現(xiàn)巴碗,use @property instead of
}
/// 順序nonatomic/atomic strong/weak/assign readonly/readwrite getter/setter
@property (nonatomic, strong) NSString *name;
// 私有變量
@interface YSYGuidelines ()
@property (nonatomic, assign) NSInteger age;
@end
#pragma mark - getter and setter
/// 重寫property屬性方法
- (NSString *)name
{
if (_name)
{
return _name;
}
_name = @"hello";
return _name;
}
空行和空格
// 其他自定義文件
//私有變量
@interface YSYGuidelines () <UITableViewDataSource>
@property (nonatomic, assign) NSInteger age;
@end
@implementation YSYGuidelines