iOS开发规范

一、命名规则

1、使用专业名词,如iOS不要写成IOS或者ios;(这个真的强迫症每次看到好多人写错心里真的有疙瘩,甚至好多大牛都写错,呜呜~~~~(>_<)~~~~)

2、尽量使用美式英语拼写确保和苹果公司的API一致;

eg:var tintColor = "red";NSString *userName = @"zhanglizzy";

2、使用驼峰式的描述性命名方式,为类,方法,变量等命名。类名的首字母应该大写,而方法和变量的首字母使用小写字符;

3、命名方式一定要能看出该名字是用来干嘛的,可以选择某些已被公认的缩写形式,eg:button可写成btn,viewController可写成VC;

4、UI控件命名格式:控件名+控件类型,eg“用户名文本框”:userNameLabel,“密码输入框”:passwordField;

5、具体参考苹果官方文档。

二、常量定义规范

1、字符串常量定义规范:

接口URL、通知名等,使用static let k… = “”命名;

Notification格式为: [Name of associatedclass] + [Did | will] + [UniquePartOfName] +Nofification(eg: UIKeyboardWillShowNotification);

2、公共常量定义在/ThankYou/Main/Common/Macro.swift文件中,用一个结构体存储对应的常量。

三、间隔

1、方法的花括号以及其他花括号(if / else / switch / while等等)总是跟语句在同一行开始,新起一行结束;(关于花括号的故事纠结了很久,现在坚持这么写是看苹果官方推出来的)如:

if user.isHappy {

//Do something

} else {

//Do something

}

2、方法之间应该总是用一个空行进行分割以提高视觉及结构上的清晰度。

四、使用标记分类代码块

每类方法前做一个Mark标记,以便于直接查看标记的方法名,而不用盲目的去查找,使整个目录清晰明了。如:

// MARK: - lifeCycle

override func viewDidLoad() {

super.viewDidLoad()

setup()

}

// MARK: - private Method

funcsetup() {

}

// MARK: - clickAction

func clickAction() {

sendMessageRequest() {

}

// MARK: - Request

func sendMessageRequest() {

}

五、注释规范

1、在每个类前添加类的用途描述:

*@author zhanglizzy, 16-04-12 11:08:29

*

*@brief用户数据单例

*

*@since 1.0

@interface UserSingleton : NSObject

2、方法注释使用VVDocumenter插件注释工具(可惜了现在Xcode8已经不能使用插件了,呜呜)

3、属性注释使用@/**<注释信息* /(可使用语句块/**<<#注释信息#>*/,这个很赞,在方法后注释,调用时可提示注释的内容)

六、适配规范

1、使用Masonry第三方框架进行界面适配(推荐使用)

2、可设置frame相对布局方式

七、控件的封装

1、封装的控件必须独立于框架,零耦合;

2、抛出的接口参数必须明确,简明扼要;

3、注释格式要规范,切带使用说明。

八、SVN使用规范

1、先更新,再提交;

2、涉及到大范围更新提交时,操作之前先备份本地代码;

3、如需替换文件,则必须先删掉被替换文件,提交,然后添加新文件再提交。

九、版本迭代要有清晰明确的版本纪录

1、明确纪录此次版本切割制作版本号;

2、此次版本所包含新增功能;

3、以及改动和修复的功能。

eg:

============== 1.1版本分界线=================

1、获取好友列表

2、BUG优化

3、发件箱消息推送

4、社交分享

5、留言接口调整

============== 1.1版本分界线==================

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 204,293评论 6 478
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 85,604评论 2 381
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 150,958评论 0 337
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,729评论 1 277
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,719评论 5 366
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,630评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,000评论 3 397
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,665评论 0 258
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,909评论 1 299
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,646评论 2 321
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,726评论 1 330
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,400评论 4 321
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,986评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,959评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,197评论 1 260
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 44,996评论 2 349
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,481评论 2 342

推荐阅读更多精彩内容

  • iOS开发规范 引子 在看下面之前,大家自我检测一下自己写的代码是否规范,代码风格是否过于迥异阅读困难?可以相互阅...
    BGDane阅读 1,361评论 1 4
  • 导语: 为规范部门 iOS开发,特制定本文档,供各位同仁参考。 语言 使用US英语, 不要使用拼音。e.g:UIC...
    攻城狮V阅读 759评论 0 0
  • 版权声明:本文为博主原创文章,未经博主允许不得转载。转载请注明转至Z.MJun的简书 1. 每一行的字数限制 80...
    ZMJun阅读 1,509评论 0 1
  • 命名原则 1.基本原则 (1)清晰。 命名应该是以清晰为主、简洁为辅。总的来讲不要使用单词的简写,除了使用非常常见...
    MichaelHuyp阅读 3,191评论 2 28
  • 每一首歌都有自己的情绪,听歌的时候脑海里会形成一个画面,或者是一个片段,又或者是一种抓不住的感觉。呐,你以后想做什...
    石明达阅读 240评论 0 1