iOS 开发代码规范有哪些

对于刚刚入门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布局库,其他的不要使用,

原文来自:博客园/梦旭

时间: 2024-10-27 02:03:10

iOS 开发代码规范有哪些的相关文章

ios开发代码规范

代码规范很重要,一个良好的代码习惯要从一开始就养成 公共类和文件的设计 (网络请求类.数据库类.Model类.View类,Controller<根据流程图>.Handle类<数据处理>.公共头文件<宏.接口的.h{URL}.常量const{通知中心的名字.一些状态码.枚举.结构体}.全局配置(适配{屏幕适配.iOS系统适配}的宏.系统版本判断.颜色值{参考图片})>) 一.文件 1.项目文件必须使用一个有意义的名字. 例如:TestDownImages 2.任何文件的命

IOS开发-代码规范

代码风格的重要性对于一个团队和项目来说不言而喻.网上有许多 Objective-C 的代码风格,但这份简洁而又最符合苹果的规范,同时有助于养成良好的代码习惯,也是我们团队一直遵循的代码风格. 写法没有对错,只是一种规范.各有各的一种规范,仅供参考. # 纽约时报 移动团队 Objective-C 规范指南 这份规范指南概括了纽约时报 iOS 团队的代码约定. ## 介绍 关于这个编程语言的所有规范,如果这里没有写到,那就在苹果的文档里: * [Objective-C 编程语言][Introduc

iOS开发代码规范(通用)

例子: MFHomeViewController View: 使用View做后缀 例子: MFAlertView UITableCell:使用Cell做后缀 例子: MFNewsCell Protocol: 使用Delegate或者DataSource作为后缀 例子: UITableViewDelegate UI控件依次类推 3> 私有变量 小驼峰式命名:第一个单词以小写字母开始,后面的单词的首字母全部大写 例子:firstName.lastName 以 _ 开头,第一个单词首字母小写 例子:N

iOS团队开发代码规范

iOS 开发代码规范 1.命名 https://github.com/Chinamobo/iOS-Team-Norms/blob/master/CodeStyle.md#naming-basic-principle https://github.com/foxsofter/ios-code-style https://github.com/andy0323/iOS-Code-Specification 新建.h,.m文件时,文件名称应与

iOS软件代码规范

在梳理团队开发流程,收集相关流程资料时,在百度文档上发现的一篇iOS软件代码规范文档:写的非常完善,具有很强操作性.百度上下载时花了一个下载币,现和大家共享.下载地址:http://download.csdn.net/detail/smallhorse87/8660881 在此基础上,我添加了客户端上线前收尾工作的备忘事项: APP中是否装备了必备功能:统计,日志收集及发送,版本检测以及自动更新,用户反馈: 确保产品经理和设计师体验过了APP,签字画押.确保APP体现了产品和设计的构想,没有理解

Android开发代码规范(转)

Android开发代码规范 1.命名基本原则    在面向对象编程中,对于类,对象,方法,变量等方面的命名是非常有技巧的.比如,大小写的区分,使用不同字母开头等等.但究其本,追其源,在为一个资源其名称的时候,应该本着描述性以及唯一性这两大特征来命名,才能保证资源之间不冲突,并且每一个都便于记忆. 对于理解应用程序的逻辑流,命名方案是最有影响力的一种帮助.名称应该说明“什么”而不是“如何”.命名原则是:使名称足够长以便有一定的意义,并且足够短以避免冗长.唯一名称在编程上仅用于将各项区分开.以下几点

北京天宇联科技有限责任公司—T语言Ios开发命名规范

T语言(ttyu software language )是一种通过定义的方式自动生成原生态的android.ios和自适应各浏览的h5的web页面的三合一的软件开发语言.T语言是一种简单的,易于使用的开发软件.T语言运用TC简单开发. TC简单开发是国内首款免费多线程的图形界面脚本制作开发工具软件,支持中英文双语言编写脚本程序,综合脚本开发工具,可以说TC开脚本界先河,是免费脚本开发制作工具的首选.通过制作脚本,可以让TC简单开发代替您的双手,自动执行一系列鼠标键动作.能陪伴你每日每夜的脚本开发

web前端开发代码规范

1. 引言 对于一个多人团队来说,制定一个统一的规范是必要的,因为个性化的东西无法产生良好的聚合效果,规范化可以提高编码工作效率,使代码保持统一的风格,以便于代码整合和后期维护.本文档主要描述web项目开发中所使用的html.css.JavaScript等规范,请参与开发相关人员遵循,同时也请各位日后进行补充完善. 2. HTML/CSS规范 2.1 浏览器兼容 根据业务要求而定: 主流程测试:Chrome 30+.IE9+: 完整测试: Chrome 21.IE8+.360浏览器.微信webv

JAVA技术开发规范(4)——JASMP平台的开发代码规范

4.关于代码规范 代码规范对程序员的重要性: 1.在软件开发生命周期中,有80%的时间是用在维护上 2.几乎所有的软件维护者都不是创使人 3.迭代式开发,必须要有清晰.可读性强的代码,以便于快速迭代 4.敏捷开发时,对应文档的输出不是减少,而是更加实用,因此,可交付的易读的代码更为重要了 5.协同协同,必需确保在编码时遵循统一的规范 编码规范是必需的,每个参与人必需严格遵循该规范进行编码. 4.1.命名规范 基本原则: 1.采用英文全称进行命名 2.保持各层级名称基本统一 3.命名英文单词用全称