20170620基础知识-编码规范

1、命名规范

大驼峰法:常量、枚举成员、类、结构体、枚举、协议、文件名、扩展文件(原始类型名+扩展名)

小驼峰法:变量、属性、函数、方法

2、注释

文件注释:开头,包括:版权信息、文件名、所在模块、作者信息、历史版本信息、文件内容、作用

文档注释:生成API帮助文档,类型、属性、方法、函数,应该是非私有  单行:///  多行:/**。。。*/

代码注释:给看源码的人参考;文档注释给看不到源码的人参考

地标注释:MARK(用于方法、函数的注释) TODO(表示这里的代码有没有完成或者还要处理)  FIXME(表示修改了代码)

3、声明

①每行声明变量或者常量的数量为1个

②尽量采用类型判断

③如果不是默认数据类型,需要明确声明变量或常量的数据类型

④变量或常量与冒号之间没有空格,冒号和数据类型直接有一个空格

⑤尽可能使用Swift原生的数据类型

⑥只读的计算属性,尽量省略get语句, var fullName: String { return firstName + “.” + lastName }

4、代码排版

空行:类型声明之前、import语句前后、两个方法函数之间、注释之前、一个源文件的两个片段之间

空格:赋值符号“=”前后各有一个空格、var let与标识符之间有空格、二元运算符用空格与操作数分开、“(”的右边“)”的左边不应该有空格、大括号前有一个空格、方法与第一个参数之间没有空格,后面的参数前要有一个空格,参数与冒号之间有空格

断行:一行代码的长度应尽量不超过80个字符

对于较长的代码的断行:在一个逗号后面断开、在一个操作符前面断开,选择较高级别的运算符、新的一行相对于上一行缩进8个空格(2个级别)

缩进:包含{}的代码块中,代码块的内容相对于首行缩进4个空格(1个级别)、if条件的断行,要缩进8个空格(2个级别)

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

推荐阅读更多精彩内容