一、基本目录结构:
1、FCKit:主要包含(FCBaseCell、动画Kit、Category等)
2、FCBase:主要包含(FCBaseModel、BaseVC、Tool等)
3、FCNetWork:主要包含(FCBaseRequest、等)
4、ThirdParts:(第三方的源码)-- tip: 源码少的,需要自定义的可以用这种方式添加,否则用Pod方式。
5、APPDelegate:(APPDelegate和相关类目)
6、具体模块的文件夹:(Home、PersonCenter、More等)
二、基本编码规范:(好的命名是基础,不能因此而省略注释~)
1、新建UIViewController、UITableViewCell、Model都要继承父类,便于引入头文件、公用通用的方法。命名例子:HomeVC、HomeCell、HomeModel
2、方法、属性、宏的(命名、空格、换行、注释)例子:
方法的例子:(注释快捷键是:command+option+/),"+"后面有个空格,后面的”{“ 前面有个空格并且不要换行
/**
* 判断字符串是否含表情
*
* @param string 原有字符串
*
* @return 返回是否有标题
*/
+ (BOOL)stringContainsEmoji:(NSString *)string {
}
属性的例子:(特别需要提示的注释可以用"///"在上面,否则可以直接写后面,尽量保持注释对齐)
/// 用户id
@property (nonatomic, strong) NSString *userId;
@property (nonatomic, strong) NSString *urlString; // 网络的url
@property (nonatomic, strong) NSString *loadHTMLURL; // 本地的url
宏的例子:(按类型分类:UtilMacro.h、SizeMacro.h、NotificationMacro.h、ThirdMacro.h等)
1、尺寸相关的宏一般用全大写,下划线分割
/// 主屏的宽
#define SCREEN_WIDTH [[UIScreen mainScreen] bounds].size.width
2、UtilMacro.h相关的一般是”k“开头,下划线分割,可读性强
#define kAnimation_Time 0.3f
2、ThridMacro.h相关的一般是”k“开头,可读性强
#define kUmengKey @"aaaaaaaaa" // 友盟key
#define kBuglyId @"aaaaaddd" // Bugly的id
循环、判断的例子:(注意空格和换行)
// 判断语句,注意空格、换行
if (self) {
} else {
}
// 循环语句,注意空格、换行
for (NSString *itemStr in array) {
}
Tip: 上面是最常用的规范,也是最简单的规范,发现好多开发者对最基本的规范都不遵守。导致代码很乱,看着很不爽。(感觉上面的规范只要遵守好,不至于代码很乱)
网友评论
*******
}
还是if () {
*******
}
还是if() {
*******
}