关于代码规范的问题

我新手,并且还是独立开发,所以自己的代码有很多都不符合规范,为了不被后来人骂死😑【当然最多的是为自己好】,我觉得有必要了解下代码规范,所以今天上午就查了下网上的资料,总结了以下内容
首先说下为什么要代码规范吧,至少有以下几点:

1) 代码可读性提高了
2) 时间久了自己再维护可以一眼看懂方法的含义
3) 便于后来者看懂并理解你的代码【据说很多人在维护“前辈们”代码的时候,都有种想砍人的冲动= =】
4) 可以提高代码的健壮性【这个不是瞎掰,且看后面介绍】

关于可读性,你们看看我前后的代码对比吧

这是创建标签栏之前的代码

乍一看觉得还行啊,什么驼峰规则,方法名首字母大写都遵守了,但是这样的代码看久了会累,为什么,不够直观!我必须要从头看到尾才能看清楚每一个参数,所以我就引用了第一条规则:如果一行有非常多的参数,更好的方式是将每个参数单独拆成一行。如果使用多行,将每个参数前的冒号对齐
所以我的代码变成了这样

这样是不是整齐了?

首先说这样写的好处吧,第一,短,第二,齐,这样看起来就很舒服,大家觉得呢?
这里用到的规则说一下:
1. 方法名首字母小写,方法中要遵守驼峰规则【也就是单词首字母大写】
2. 单行一般不能超过80列,提高可读性【设置Xcode > Preferences > Text Editing > Show page guide,来使越界更容易被发现】
3. 方法参数取名应该直观易懂
4. 多个参数要拆行,以冒号对齐【如果第一个参数太短了,可以缩进一下】

再讲一下关于变量命名吧,只要记住一点,不要担心浪费行宽,让看代码的人能看懂并立即理解更重要
错误示例:
int  w;
int nErr;
正确示例:
int width;
int numErrors;

然后就是代码的健壮性了,好的代码有助于提高运行效率不是吗?其中主要有以下几点:
1) 创建临时对象时在同一行使用自动释放池,而不是后面单独加一个release【MRC】,可以有效避免意外删除了release导致的内存泄漏
例如:MyViewController *controller = [[[MyViewController alloc] init] autorelease];
2) 不要在构造方法【init】中将成员变量初始化为 0 或者 nil;毫无必要 ,刚分配的对象,默认值都是0,除了isa指针
3) 使用alloc init方法创建并初始化对象,不要使用new,也没必要重载它,new会让有关内存分配的代码审查更困难

最后就是文件注释了,Xcode默认新建一个类之后它的文件注释默认是这样的

其实我只想问问这个有什么卵用?

在实际开发中文件注释如果写上的话是非常有用的,每个文件的开头以文件内容的简要描述起始,最好再简要描述一下功能,紧接着是作者,最后是版权声明和/或许可证样板。做个简单地示范,例如这样:

注明了不能更改了,更改小心翻脸哦

这样是不是就能看出来这个文件是干嘛的了?之后再维护的话是不是会更方便呢?说起这个又要吐槽一下苹果了,本来这个注释咱们是可以在Xcode ▸ Contents ▸ Developer ▸ Platforms ▸ iPhoneOS.platform ▸ Developer ▸ Library ▸ Xcode ▸ Templates▸File Templates▸Source▸Cocoa Touch Class.xctemplate  这个目录下更改的,但是自从8之后就被锁了,所以还是自己封一个代码块吧,这个看个人需要我就不分享自己的代码块了😄
先写到这里了,以后再看到什么有用的再添加,欢迎大家批评指正

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

推荐阅读更多精彩内容

  • iOS编程规范0规范 0.1前言 为􏰀高产品代码质量,指导广大软件开发人员编写出简洁、可维护、可靠、可 测试、高效...
    iOS行者阅读 4,431评论 21 35
  • 代码格式 使用空格而不是制表符 Tab 不要在工程里使用 Tab 键,使用空格来进行缩进。在 Xcode > Pr...
    small_Sun阅读 1,345评论 1 3
  • 推荐文章:禅与 Objective-C 编程艺 前言 为􏰀高产品代码质量,指导广大软件开发人员编写出简洁、可维护、...
    WolfTin阅读 2,749评论 0 1
  • Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具(例如配置管理,服务发现,断路器,智...
    卡卡罗2017阅读 134,596评论 18 139
  • 终有一天,我会感激上帝为我关了美股这扇窗
    新兴市场的小逻辑阅读 109评论 0 0