iOS团队编码规范

作者: 臭码农 | 来源:发表于2017-03-28 15:59 被阅读5394次

不规范的代码,读起来身心俱惫,改起来后患无穷。


命名原则:

1.最少字符,尽量的减少命名对象的长度,选择字符少的名词

2.名符其实,命名应该能直观的描述被命名对象是什么或者做什么

3.避免歧义,尽量不要采用多义词,也不要使用命名组合之后产生多义的方式

4.上下文一致,比如谓词的统一性,如果都是集合类,那么使用Remove表示删除操作,那么所有上下文就应该都用这个Remove,而不要再用Delete

5.少用缩写,除非是很常见的缩写或者项目中定义好的缩写,否则不要使用缩写

6.优先使用全局常量而非宏,应使用static方式声明常量;

一、目录命名

以功能模块划分目录,使用大驼峰法命名,例:Discovery,并关联实体文件夹。

二、类命名

遵循命名原则,使用大驼峰法命名,通常在类的头部.h文件添加类注释,标明该类的用途。

三、属性命名

1. 一般变量名使用小驼峰命名规则,不要使用下划线。

2. 类属性变量用小驼峰法。

3. 类的成员变量用小驼峰命名法并加上下划线开头的方式命名。

四、方法命名

使用小驼峰法命名,方法名使用动词短语,能具体表达出该方法的功能,参照系统方法:

更多编码规范请参考:https://github.com/raywenderlich/objective-c-style-guide

注释规范


链接到另一篇文章:iOS代码注释方法大全,图文介绍如何使用快速注释

文章介绍各类注释方法、应用场景,并搭配快捷键实现快速注释。

以上属于臭码农原创,若有雷同属巧合,如有错误望指正,转载请标明来源和作者。by:臭码农

相关文章

  • iOS团队编码规范

    前言 关于深拷贝与浅拷贝,一直以来都是面试官喜欢吃的菜,而经验不足的求职者经常会进入误区,不理解深拷贝与浅拷贝的实...

  • iOS团队编码规范

    前言 最近有不少朋友遇到了这样的需求:一个界面上有一个headerView、一个toolbar和一个tablevi...

  • iOS团队编码规范

    团队开发一定要有很好的编码规范才利于团队开发与快速维护。我相信大家在维护老代码的时候,都有这么一种心理:真想骂死那...

  • iOS团队编码规范

    不规范的代码,读起来身心俱惫,改起来后患无穷。 命名原则: 1.最少字符,尽量的减少命名对象的长度,选择字符少的名...

  • ios团队编码规范

    1.见名知义。命名应该直观的描述命名对象,避免歧义。 2.上下文一致。比如删除,在前面使用了remove,后面就不...

  • iOS 团队编程规范

    iOS 团队编程规范 前 言 一、命名规范 二、代码注释规范 三、代码格式化规范 四、编码规范 参考资料: 转载自...

  • 搜狐视频iOS团队 Objective-C 编码规范

    搜狐视频iOS团队 Objective-C 编码规范 介绍 团队中长期以来存在各人不同的编码方式和习惯,导致代码中...

  • iOS开发 | 规范编码的四个意识

    iOS开发 | 规范编码的四个意识 iOS开发 | 规范编码的四个意识

  • iOS 编码规范

    Table of Contents iOS 编码规范1 文件规范1.1 文件编码1.2 文件命名2 编码格式2.1...

  • iOS(Objective-C)编码规范

    iOS(Objective-C)编码规范 本文件旨在统一****iOS方向编码规范。增强代码可读性,便于后期维护。...

网友评论

    本文标题:iOS团队编码规范

    本文链接:https://www.haomeiwen.com/subject/ozsrottx.html