iOS OC开发代码规范

简介: 1.变量、类名、函数名 使用驼峰命名法2.尽量使用完整的单词命名,尽量不采用 缩写单词3.类名使用大写字母打头,前缀统一加上HH 例如:HHHomePageController4.类的成员变量使用 下划线打头, 例如_age5.禁止在项目中的任何地方,包括文件名、目录名、逻辑目录名、项目名等地方使用空格或中文字符6.为了不影响阅读,一个方法中代码不要超过100行。

 

1.变量、类名、函数名 使用驼峰命名法

2.尽量使用完整的单词命名,尽量不采用 缩写单词

3.类名使用大写字母打头,前缀统一加上HH 例如:HHHomePageController

4.类的成员变量使用 下划线打头, 例如_age

5.禁止在项目中的任何地方,包括文件名、目录名、逻辑目录名、项目名等地方使用空格或中文字符

6.为了不影响阅读,一个方法中代码不要超过100行。一个类中代码不要超过600行, 有超过的再回头重构的时候想办法分解

7.每个.h文件最开始处用简短文字说明一下该类的功能

8.类中第___个功能模块以 #pragma mark - 分隔,上空两行,下空一行

9.常用对象 命名采用后缀,如下 

UIView: View   例如:UICandidateView : viewCandidate;

UILabel: Lab 例如: UICopyLabel: labCopy;

UIButton: Btn 例如:  UISelectedButton:  btnSelected;

UIImage:  img      imgAvatar;

UIImageView:  imgViewAbc

UITextField:  textFiledName;

UITextView:  textViewEdit;

NSArray:  arrName;

NSMutableArray: mArrName;

NSDictionary: dictPosition;

NSMutableDictionary :MDictPosition;

NSString :strName;

NSMutableString :mStrName;

NSAttributedString :attributedStrName;

NSMutableAttributedString :mAttributedStrName;

 

10. 文档注释格式如下

    /**

    方法或变量名说明

     @param 参数1说明 

     @param 参数2说明

     ...

     @return 若方法有返回值,则对返回值进行说明

    */

12. 注意 常量和宏的声明

CGFloat cellHeight = 12.0f;

static CGFloat const cellHeight = 12.0f;

static NSString *const JumpNotificationName = @“JumpNotificationName”;

 

13.关于.h空行规定

13.1.文件说明与头文件包涵(#import)之间空1行

13.2.头文件包涵(#import)之间如果需要分类区别,各类别之间空1行

13.3.头文件包涵(#import)与@class之间空2行

13.4.@interface与@class之间空1行

13.5.头文件{}里面,空1行开始声明成员对象,如果需要分类别,各类别之间空1行

13.6.{}外空一行开始书写属性,如果需要分类,各类别之间空1行

13.7.空1行书写方法,如果各方法之间需要分类别,各类别之间空1行

13.8.方法完成之后,空1行@end

13.9.如果需要声明protocal,空2行接着写。通常protocal写在@end后,但是声明在@interface前,也可以另写1个文件

 

14.关于.m中空行的规定

14.1.文件说明与头文件包涵(#import)之间空1行

14.2.头文件包涵(#import)之间如果需要分类区别,各类别之间空1行

14.3.@implementation和@synthesize之间空1行,@synthesize不要使用逗号(,)如果需要分类区别,各类别之间空1行

14.4.@synthesize与 法之间空2 

14.5.各方法之间空2行

 

15.方法里面的空行 

15.1.方法名后空1行开始写 

15.2.变量声明后需要空1行,如果需要分类区别区分,各类别之间空1行

15.3.条件,循环,选择语句,整个语句结束,需要空1行

15.4.各功能块之间空1行

15.5.最后1个反括号之前不空

15.6.注释与代码之间不空

15.7.#pragma mark与方法之间空1行

 

16关于空格

16.1.h中协议<>前 有1个空格

16.2.h中成员声明时,类型与变量之间有少1个空格。星号(*)靠近变量,不靠近类型

16.3.@property后有1各空格,()里面,逗号后面有1个空格,括号外面,先留1个空格,再声明属性

16.4.方法+,-后,与()之间有1个空格

16.5.返回类型与*之间有1个空格, 方法参数中返回类型与*之间有1个空格

16.6.多参数的方法,每个参数后都有1个空格

 

17.关于bool值

17.1.不要 if(obj==nil){},  if(!obj){}

17.2.比较时把常量放前 可以避免错误

17.3.不要 if(aBool==YES){},直接 if(aBool){} 或if(!!aBool){}

 

18.变量属性名和其它

18.1.尽量在使用的时候才声明变量,尽量少声明全局变量

18.2.变量名不要只使1个字 ,尽量能表明变量的意思

18.3.@synthesize和@dynamic,应该放在类实现的最上面,每一个声明都单独一行

18.4.协议protocol需要加#pragma marks-来区分

18.5.obj = nil; delegate也应该在dealloc里面写  delegate = nil;

 

19其它

19.1@interface与@implementation与import之间空1行

19.2属性的声明和实现,尽量避免书写@synthesize,如果用到@synthesize,要紧接着@implementation书写,不要换行

19.3成员变量尽量写在@implementation内部,有必要对外暴露时,才写在@interface下

19.4临时变量的声明,尽量赋初始值, eg: NSInteger a = 0;

19.5声明多个临时变量,必须另起一行,禁止书写 int a = 3, b = 5;

19.6临时变量的声明语法写完后,必须各行开始书写逻辑代码,逻辑代码中可以穿插 临时变量的声明,同样必须隔行书写 

19.7遇到新的代码块,必须隔行书写。包括函数的实现,if, switch分支,while,do while,for循环等

19.8所有的代码块必须用{}, 即只有1行的if代码也必须用{}, 

 if (success) {
         return YES; 

 }

19.9所有的二次元运算符,必须以空格隔开,如 x += 12, 不能写成 x += 12;

19.10.所有的逗号后必须追加一个空格, 例如CGRectMake(12, 12, 43, 40);

19.11.尽量用NSInteger 取代int, 用NSUInteger 取代unsigned int

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