首页 > 代码库 > ios基础-编程规范
ios基础-编程规范
养成良好的编程习惯,是开始一门新语言的首要前提。
(一)文档结构规范
1.建立Libs文件夹,存放第三方库
2.建立Tools文件夹,存放自己封装的类库
3.建立ViewControllers文件夹,存放所有的ViewControl
4.建立Request文件夹,存放网络请求
5.建立Cell文件夹,存放列表item
6.在Supporting Files文件夹下建立Images、Music和Video等相关文件夹,分别存放图片、音频、视频等资源。
7.建立RootViewController首页,放在底层目录
8.建立Constant.h文件,放在底层目录,存放常量
范例如下:
(二)命名规范
1.常量名全大写,可用下划线分隔,如:MY_LOTTERY_ID
2.变量首字母小写,后面单词首字母大写,如myLotteryId
3.类名首字母大写,如@interface MyLotteryId:NSObject
4.命名时带上类型,如xxxTv,xxxView,xxxStr等
常见类型简写如下:
UIViewController:VC UIImage:Img UIImageView:Iv
UIView:View UILabel:Lbl UIButton:Btn
UINavigationBar:NBar UIToolBar:TBar UISearchBar:SBar
UITextField:Tf UITextView:Tv NSArray:Array
NSMutableArray:MArray NSDictionary:Dict NSMutableDictionary:MDict
NSString:Str NSMutableString:MStr NSSet:Set NSMutableSet:MSet
5.静态变量前面加s标示,如sLotteryId
更多命名规范可参加苹果官方文档
(三)编码习惯
1.每个文件前简要描述该文件作用
2.类中功能模块用#pragma mark - 做好备注,方便查找和代码管理
3.NSLog测试完统一删除
4.程序中变量方法名,尽量用命名标示功能,无法标示的用注释说明
5.在pch文件中做加载预处理和log自动去除设置
6.类代码行数尽量不超过300行,一个函数不超过100行,超过的考虑重构
7.创建Constant.h文件存放常量