对于刚刚入门ios的同学来说,iOS 开发代码规范是很重要的知识的,这里就给大家简单总结了一下。
一.工程规范
1.功能分类
根据所做功能的不同,分为不同的功能模块,比如登录模块,首页模块,个人模块等,根据不同的功能,代码必须要放在不同功能的文件夹下。
2.代码文件分类
不管是MVC模式,MVVM模式,或是其他设计模式,在不同的功能模块下,视图控制器(Controllers),视图(Views),模型类(Models),也必须要分别存放。
3.第三方库分类
工程中会经常使用第三方库,在引入第三方库时,必须要把其存放在单独的文件夹内,每个第三方库,也必须要以不同的文件夹区分开,不能全部放在一个文件夹中,第三方库的主文件夹以“Library”命名。
4.工程设置
创建的工程,必须要能兼容iOS7.0及以上的系统,引入的第三方库也必须兼容iOS7.0及以上系统,关于64位的兼容也是必须的。
示例:
二.代码规范
1.文件命名规范
创建的Controllers,Views,及Models,命名必须规范,首先必须要有前缀且一个工程中必须唯一,其次命名必须体现功能,不能简写,更不能以汉语拼音首字母简写,全部使用英文,或是英文简写。
示例:
Controller: HSHomeViewControllers,LSSPersonCenterViewController等,前缀自定,但工程中必须唯一;
View:HSHomeHeaderView ,LLPersonInfoView 等;
Models:ZYYUserInfoModel,ZHPersonInfoModel,等;
2.代码编写规范
代码文件中,.h 文件只能包含必要暴露出来的属性列表或是必要的方法,而本类中所要使用的属性,全部在.m中进行声明,对于声明的属性必须要添加相应详细的注释,使用“///xxxxxxx” 来标明属性的作用,
示例:
///用户信息列表TableView
@property (nonatomic , strong) UITableView * tableView;
///用户列表数据ListArray
@property (nonatomic , strong) NSArray * listArray;
对于Controller类中所有的功能实现的方法,必须区分开,ViewDidLoad方法中不要写入太多代码,功能实现以调用相应的方法来做。
相同的功能性方法要区分开,
使用“ #pragma mark -- <#information#> ” 来区分不能功能模块,
使用“///xxx方法,实现xxx功能” ,来区分不同方法的作用
例如:
#pragma mark -- 界面创建
///创建TableView的头部视图headerView
/// 创建xxxxxxxxxxxx
#pragma mark -- 网络请求
///用户信息更新
///请求xxxxxxxxxxxx列表信息
…….
注:所有的命名必须使用英文及通用的英文缩写,不能使用汉语拼音,也不能使用英文首字母简写(除非是通用英文缩写)或是拼音首字母简写,命名规则也必须以驼峰命名法为主,同时命名必须有一定含义,不能随意写。
三. 其他注意事项
1.尽可能的使用相应的设计模式,MVC,MVVM等,最好使用MVC模式,
2.网络请求最好封装成相应的方法,方便统一调用及修改,必须使用第三方AFNetWorking来做网络请求,
3.共性的方法最好抽出来放到一个文件内,方便调用,防止过多重复性代码,
4.最好采用纯代码编写程序,方便修改,
5.关于布局最好采用第三方Masonry布局库,其他的不要使用,
原文来自:博客园/梦旭