iOS 代码规范

概述

命名的好坏在开发中往往也不怎么重视,毕竟差的命名也不会影响程序逻辑。但是不好的命名在大项目中带来的隐形维护成本是相当高的,这些在项目开始时可能还很难察觉,而后来会陷入前仆后继的维护困境中。我们往往非常重视项目逻辑的复杂性,却不能好好的把“简单”的命名做好。其实,如果简单的东西都做不好,那么做出再复杂的东西那也是垃圾。

命名规范

分类(类别)命名

与类命名相同,此外需添加要扩展的类名和“+”

举例:NSString+URLEncoding

协议(委托)命名

与类命名相同,此外需添加“Delegate”后缀

举例:ReplyViewDelegate

方法命名

首字母小写,之后每个单词首字母都大写

方法名使用动词短语

举例:- (void)setupPostWithValue:(int)value

“要什么”往往被胡乱命名为get开头的方法。首先get是一个动词,所以它还是“做什么”或者说“做的是要什么”。那么get方法不要用于返回对象,但它可用于参数。

- (XXItem *)getItemAtIndex:(NSUInteger)index                  //Bad!! 不规范的命名
- (XXItem *)itemAtIndex:(NSUInteger)index                     //Good, 命名清晰
- (void)getItem:(XXItem **)outItem atIndex:(NSUInteger)index  //比较符合规范,但第二种更好。

参数命名

首字母小写,之后每个单词首字母都大写

每个参数前要加参数的名称提示

举例:

- (id)initWithNibName:(NSString *)nibNameOrNil bundle:(NSBundle *)nibBundleOrNil
- (void)performSegueWithIdentifier:(NSString *)identifier sender:(id)sender

对象命名

采用修饰+类型的方式

时间: 2024-08-11 07:48:33

iOS 代码规范的相关文章

iOS代码规范

前言 开发iOS至今已经有一年多的时间了,一直没有对代码做一个比较好的规范,最近公司人手逐渐增多,每个人写的代码都是无花八门,看着十分不习惯.于是综合网上一些人的经验和自己的一些编程习惯,总结出了如下的iOS代码规范. 命名规范 类命名 首字母大写,之后每个单词首字母都大写 使用能够反映类功能的名词短语 文件和类同名 特殊类命名 如果是视图控制器的子类应添加后缀"ViewController"或者"Controller",BeeFramwork中加"Boa

iOS代码规范(Swift 与 OC 混编版)

前言 按照自己的理解整理的 iOS 代码规范,部分规范参考了网上现有的一些资料,希望对大家有所帮助 编码规范 项目结构规范 项目结构图 |-业务1 | |-业务1的Storyboard | |-子业务1 | | |-controller | | |-view | | `-model | |-子业务2 | | |-controller | | |-views | | `-models |-业务2 | |-业务2的Storyboard | |-子业务1 | | |-controller | | |-

(转)ios 代码规范

转自http://blog.csdn.net/pjk1129/article/details/45146955 引子 在看下面之前,大家自我检测一下自己写的代码是否规范,代码风格是否过于迥异阅读困难?可以相互阅读同伴的代码,是否存在阅读障碍? 若存在晦涩难懂的,理解成本增大的代码,说明你的团队需要自省了. 下面总结一下OC编程中的一些代码规范(苹果官方推荐的).以OC为示例,但不局限于OC,也可以被当作别的编程语言的开发规范约定(仅需要把OC特有的东西按照你所使用的语言的惯例即可) 参考资料:苹

iOS学习:iOS代码规范

作者感言 阅读前言 iOS代码规范 Import规范 Define规范 Paragma Mark 规范 Interface规范 implementation规范 实例规范 NSDictionary规范 NSArray规范 函数规范 If-Else规范 For-In For 规范 Block规范 运算符规范 命名规范 实例命名规范 Property命名规范 Interface-class命名规范 Define命名规范 Block命名规范 For-In命名规范 布局框架 文件夹层次结构 MVC架构

iOS代码规范(OC和Swift)

下面说下iOS的代码规范问题,如果大家觉得还不错,可以直接用到项目中,有不同意见 可以在下面讨论下. 相信很多人工作中最烦的就是代码不规范,命名不规范,曾经见过一个VC里有3个按钮被命名为button1.button2.button3,全文没有注释,去看代码逻辑才能知道这三个按钮的意思,我也是醉了! 下面的规范 有的定的比较死,大家可以根据自己团队的风格进行修改.该文章主要是OC的代码规范,有几个是Swift的规范. OC和Swift的代码规范如下: 一.VC生命周期 模块排列顺序 1. 注意

iOS开发笔记--iOS开发规范

iOS开发规范 原文地址:http://blog.csdn.net/pjk1129/article/details/45146955 引子 在看下面之前,大家自我检测一下自己写的代码是否规范,代码风格是否过于迥异阅读困难?可以相互阅读同伴的代码,是否存在阅读障碍? 若存在晦涩难懂的,理解成本增大的代码,说明你的团队需要自省了. 下面总结一下OC编程中的一些代码规范(苹果官方推荐的).以OC为示例,但不局限于OC,也可以被当作别的编程语言的开发规范约定(仅需要把OC特有的东西按照你所使用的语言的惯

iOS开发规范

下面总结一下OC编程中的一些代码规范(苹果官方推荐的).以OC为示例,但不局限于OC,也可以被当作别的编程语言的开发规范约定(仅需要把OC特有的东西按照你所使用的语言的惯例即可) 参考资料:苹果代码规范 对建议的代码规范的说明 命名 命名规则对于维护代码来说是非常重要的,.Objective-C方法名往往很长,不过这也有好处,让很多注释变得毫无意义. 本文推荐驼峰法,也是Objective-C社区的标准. 驼峰法分小驼峰法和大驼峰法.小驼峰法:除第一个单词之外,其他单词首字母大写.大驼峰法相比小

ios开发代码规范

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

iOS 开发代码规范有哪些

对于刚刚入门ios的同学来说,iOS 开发代码规范是很重要的知识的,这里就给大家简单总结了一下. 一.工程规范 1.功能分类 根据所做功能的不同,分为不同的功能模块,比如登录模块,首页模块,个人模块等,根据不同的功能,代码必须要放在不同功能的文件夹下. 2.代码文件分类 不管是MVC模式,MVVM模式,或是其他设计模式,在不同的功能模块下,视图控制器(Controllers),视图(Views),模型类(Models),也必须要分别存放. 3.第三方库分类 工程中会经常使用第三方库,在引入第三方