【iOS】iOS开发编码规范小结

简介: 规范编码可以提高代码的可读性,降低维护成本。作为一个程序员,要对自己写的代码负责,虽然bug无可避免,但是写代码时最基本的编码规则还是应该遵守的,否则不是坑自己就是坑别人,因为代码肯定是要维护的。下面我主要讲一下从建项目到开发写代码时应该注意的一些地方和自己的一点建议。

规范编码可以提高代码的可读性,降低维护成本。作为一个程序员,要对自己写的代码负责,虽然bug无可避免,但是写代码时最基本的编码规则还是应该遵守的,否则不是坑自己就是坑别人,因为代码肯定是要维护的。
下面我主要讲一下从建项目到开发写代码时应该注意的一些地方和自己的一点建议。

  • 项目名称:项目名字的英文或者拼音全拼形式(如果比较长也可以选择缩写),建议每个单词或者拼音的首字母都大写。
  • Bundle Identifier:唯一标识符,最好包含公司的名字和项目名字,我一般用的格式为:www.公司名称或缩写.项目名称.www,已经被别人在开发者证书中心注册过的Bundle Identifier就无法再次添加到自己的证书中心,所以带上公司名和项目名可以防止用了已经被占用的Bundle Identifier。
  • 目录结构中的文件夹命名:在用xcode开发时,左边的项目目录结构用的比较多,也是一个很关键的地方,所以建议这里的文件夹目录能放的比较有层次,这样在找代码和修改代码的时候方便。文件夹的名字应该与文件夹中所放代码的作用或者所属模块相关联,名字可用英文或者拼音缩写,首字母大写,中文也是可以用的,但是我个人不建议用中文,原因大家都懂。文件夹可以含多层,比如首页模块的功能,第一层可以是Home文件夹,然后在这个里面可以再细分视图、数据、交互等。另外有些人也有习惯给代码中的文件夹加上统一的前缀,这也是可以的,看上去也很舒服。
  • 类名:建议带上固定的前缀和相应的后缀,在二者之间填上类所实现的功能。先来说固定的前缀,比如说AFNetWorking,这个第三方库,类名都是以AF开头的,我们自己写的类名也可以,这个前缀可以用项目名字的首字母缩写、公司名缩写或者任何你喜欢的字母组成,加这个前缀有两个好处,一个项目目录整齐,还有一个就是项目中的模块拿到别的项目中使用可以很大程度上降低类名相同而造成不能直接使用的概率。相应的后缀指的是此类所属的类型,比如如果此类为ViewController的子类,那么类名可以以ViewController或者简写成VC来结尾,这样这个类是个ViewController还是个view一目了然。中间为此类要实现的功能相关是为了看类名就能知道这个类是干什么用的,比如MMHomeViewController这个类名,MM为项目名称缩写,Home代表首页,ViewController表示该类为一个视图控制器,一看这个类名就很容易知道这个类中写的是首页的实现的代码。有一些继承自NSObject类的单例可以以Manager为后缀。类名首字母大写。
  • 成员变量:最最基本的应该见名知意,最好有变量对应的类型的后缀,首字母小写。比如loginButton,这样就很好理解,一看就知道这代表一个登录按钮。成员变量是整个类都能用的,如果起名很随意,代码理解起来可能比较困难。首字母小写,遵守驼峰规则。
  • 局部变量:同上需要见名知意,虽然存在的范围小,但是也很影响阅读性,千万不要取什么arr1、arr2之类的,很难知道里面放的是什么。首字母小写,遵守驼峰规则。
  • 代理/协议名:该协议对应的类的类名+Delegate/Protocol,首字母大写。
  • 方法名:每个参数前的英文块首字母小写,遵守驼峰规则。方法名以该方法所实现的功能为主,所需参数的参数名最好能带上该参数的类型,这样调用起来方便,看方法名可知在哪儿用,看参数名可知所需什么参数。
  • 注释:在这里特意加上注释,其实并不是要谈注释的规范,而是想说,命名不会规范的程序员在写代码的时候记得多写点注释,绝对没坏处!!!

最后说一下自己的亲身体验,接手过一套代码,类名随便取,很多继承自ViewController的视图控制器都以view结尾,变量名更不用说,看代码的时候还得靠猜这个变量里面放的是什么。记得印象比较深的是,在一个单例类中有一个type变量,看调用的地方挺多,有设置为1的,有设置为2的,也有拿来做判断条件的,完全不知道这个值的意义是什么。跟写代码的人沟通,他自己也忘记掉了,也不知道用的地方为什么那么用。这只是印象比较深的一个,他唯一的说辞是他自己开发技术太菜。但是我觉得,编码是否规范与技术水平高低关系不是很大,代码风格更多的是反映一个程序员的编程习惯的态度。实在不会规范,那就加注释,简单的注释一下变量是用来干嘛的等等。
编程技术水平有高低,但是认真的态度不该有差别,一个程序员可以写不出很炫很酷很牛的代码,但是千万不要随意的写出难以阅读和维护的代码!
这些规范也是我自己的一些小总结,希望能给刚入门的一些人一点提醒和帮助。

相关文章
|
1月前
|
开发框架 前端开发 Android开发
安卓与iOS开发中的跨平台策略
在移动应用开发的战场上,安卓和iOS两大阵营各据一方。随着技术的演进,跨平台开发框架成为开发者的新宠,旨在实现一次编码、多平台部署的梦想。本文将探讨跨平台开发的优势与挑战,并分享实用的开发技巧,帮助开发者在安卓和iOS的世界中游刃有余。
|
8天前
|
iOS开发 开发者 MacOS
深入探索iOS开发中的SwiftUI框架
【10月更文挑战第21天】 本文将带领读者深入了解Apple最新推出的SwiftUI框架,这一革命性的用户界面构建工具为iOS开发者提供了一种声明式、高效且直观的方式来创建复杂的用户界面。通过分析SwiftUI的核心概念、主要特性以及在实际项目中的应用示例,我们将展示如何利用SwiftUI简化UI代码,提高开发效率,并保持应用程序的高性能和响应性。无论你是iOS开发的新手还是有经验的开发者,本文都将为你提供宝贵的见解和实用的指导。
91 66
|
18天前
|
开发框架 Android开发 iOS开发
安卓与iOS开发中的跨平台策略:一次编码,多平台部署
在移动应用开发的广阔天地中,安卓和iOS两大阵营各占一方。随着技术的发展,跨平台开发框架应运而生,它们承诺着“一次编码,到处运行”的便捷。本文将深入探讨跨平台开发的现状、挑战以及未来趋势,同时通过代码示例揭示跨平台工具的实际运用。
|
22天前
|
Java 调度 Android开发
安卓与iOS开发中的线程管理差异解析
在移动应用开发的广阔天地中,安卓和iOS两大平台各自拥有独特的魅力。如同东西方文化的差异,它们在处理多线程任务时也展现出不同的哲学。本文将带你穿梭于这两个平台之间,比较它们在线程管理上的核心理念、实现方式及性能考量,助你成为跨平台的编程高手。
|
24天前
|
存储 前端开发 Swift
探索iOS开发:从新手到专家的旅程
本文将带您领略iOS开发的奇妙之旅,从基础概念的理解到高级技巧的掌握,逐步深入iOS的世界。文章不仅分享技术知识,还鼓励读者在编程之路上保持好奇心和创新精神,实现个人成长与技术突破。
|
27天前
|
安全 IDE Swift
探索iOS开发之旅:从初学者到专家
在这篇文章中,我们将一起踏上iOS开发的旅程,从基础概念的理解到深入掌握核心技术。无论你是编程新手还是希望提升技能的开发者,这里都有你需要的指南和启示。我们将通过实际案例和代码示例,展示如何构建一个功能齐全的iOS应用。准备好了吗?让我们一起开始吧!
|
1月前
|
安全 Swift iOS开发
Swift 与 UIKit 在 iOS 应用界面开发中的关键技术和实践方法
本文深入探讨了 Swift 与 UIKit 在 iOS 应用界面开发中的关键技术和实践方法。Swift 以其简洁、高效和类型安全的特点,结合 UIKit 丰富的组件和功能,为开发者提供了强大的工具。文章从 Swift 的语法优势、类型安全、编程模型以及与 UIKit 的集成,到 UIKit 的主要组件和功能,再到构建界面的实践技巧和实际案例分析,全面介绍了如何利用这些技术创建高质量的用户界面。
31 2
|
1月前
|
安全 数据处理 Swift
深入探索iOS开发中的Swift语言特性
本文旨在为开发者提供对Swift语言在iOS平台开发的深度理解,涵盖从基础语法到高级特性的全面分析。通过具体案例和代码示例,揭示Swift如何简化编程过程、提高代码效率,并促进iOS应用的创新。文章不仅适合初学者作为入门指南,也适合有经验的开发者深化对Swift语言的认识。
52 9
|
1月前
|
vr&ar Android开发 iOS开发
安卓与iOS开发中的用户界面设计原则
【10月更文挑战第41天】探索移动应用开发的精髓,本文将深入分析安卓和iOS平台上用户界面设计的核心原则。通过比较两大操作系统的设计哲学,我们将揭示如何打造直观、易用且美观的应用程序界面。无论你是初学者还是资深开发者,这篇文章都将为你提供宝贵的见解和实用的技巧,帮助你在竞争激烈的应用市场中脱颖而出。
|
1月前
|
设计模式 Swift iOS开发
探索iOS开发:从基础到高级,打造你的第一款App
【10月更文挑战第40天】在这个数字时代,掌握移动应用开发已成为许多技术爱好者的梦想。本文将带你走进iOS开发的世界,从最基础的概念出发,逐步深入到高级功能实现,最终指导你完成自己的第一款App。无论你是编程新手还是有志于扩展技能的开发者,这篇文章都将为你提供一条清晰的学习路径。让我们一起开始这段旅程吧!