美文网首页
代码规范

代码规范

作者: 求长生 | 来源:发表于2020-06-01 14:14 被阅读0次

一、命名规范

命名原则:清晰和简洁,避免歧义。整个工程保持一致性。
类名、协议名命名:大驼峰式命名,每个单词的首字母都采用大写字母。(类名)
属性名、方法名:小驼峰式命名,第一个单词以小写字母开始,后面的单词的首字母全部大写。(属性)
私有变量命名: _ 开头,例:NSString *_someVariable;
属性关键字顺序:原子性,读写,内存管理的顺序排列。@property (nonatomic, readwrite, copy) NSString *userName;
宏定义的常量:#define常量全部大写,单词间用 _ 分隔,#define MY_MIN(A, B) ((A)>(B)?(B):(A))。
类型常量:以字符k开头, static NSString * const kClearCacheNotification = @"kClearCacheNotification";。
{建议使用类型常量,不建议使用#define预处理命令
预处理命令:简单的文本替换,不包括类型信息,并且可被任意修改。
类型常量:包括类型信息,并且可以设置其使用范围,而且不可被修改。
}
Enum类型:的命名与类的命名规则一致Enum中枚举内容的命名需要以该Enum类型名称开头。
typedefNS_ENUM(NSInteger,UIViewAnimationTransition) {UIViewAnimationTransitionNone,
UIViewAnimationTransitionFlipFromLeft,
UIViewAnimationTransitionFlipFromRight,
UIViewAnimationTransitionCurlUp,
UIViewAnimationTransitionCurlDown,};
范型:建议在定义NSArray和NSDictionary时使用泛型,可以保证程序的安全性。

NSArray<NSString *> *testArr = [NSArray arrayWithObjects:@"Hello", @"world", nil];
NSDictionary<NSString *, NSNumber *> *dic = @{@"key":@(1), @"age":@(10)};

iOS 9新特性、泛型、__kindof的使用

二、代码注释规范

1.属性注释 /* name /
2.方法的注释使用Xcode,自带注释快捷键:Commond+option+/
/
*
@param tableView
@param section
@return
*/
3.单行注释,/+空格
//TODO:标记一些未完成的或完成的不尽如人意的地方}

三、编码规范

编码规范就是为了保证写出来的代码可复用, 易维护, 可扩展。
每个模块(或者函数)职责要单一,架构方面多了解。

语法糖的使用
使用带有 @ 符号的语法糖来生成 NSNumber 对象能使代码更简洁。

nil 检查
// 正确,直接判断
if (!objc) {
...
}
// 错误,不要使用 nil == Object 的形式
if (nil == objc) {
...
}

属性的线程安全
定义一个属性时,编译器会自动生成线程安全的存取方法( Atomic ),但这样会大大降低性能,特别是对于那些需要频繁存的属性来说,是极大的浪费。所以如果定义的属性不需要线程保护,记得手动添加属性关键字 nonatomic 来取消编译器的优化。

Delegate 要使用弱引用
一个类的 Delegate 对象通常还引用着类本身,这样很容易造成引用循环的问题,所以类的 Delegate 属性要设置为弱引用。

参考资料:

iOS 代码规范

iOS开发总结之代码规范

iOS开发代码规范(通用)Objective-C开发编码规范

【iOS】命名规范Ios Code SpecificationApple Coding Guidelines for Cocoa

Google Objective-C Style Guide

相关文章

  • Web 端代码规范

    目录 1、代码规范概述 2、代码规范流程搭建 3、代码规范细则 1、代码规范概述 良好的代码规范能够提供软件的可读...

  • 代码规范

    代码规范 1. 概述 欢迎使用前端代码规范, 这里借鉴、引用的是京东前端代码规范。 遵循代码规范的目的在于增强团队...

  • iOS 代码规范篇

    iOS 代码规范篇 iOS 代码规范篇

  • iOS(OC)开发之随感

    1.代码规范 规范很重要!规范很重要!规范很重要! 代码规范的重要性之-为什么谷歌要执行严格的代码编写规范http...

  • 前端学习的基本总结

    目录 1.为什要遵守代码规范 2.css代码规范 3.js代码规范与设计模式3.1 js代码规范3.2 设计模式 ...

  • 乐乎项目优化

    编程: 1、代码规范。架构规范、文件组织规范、命名规范、代码逻辑规范、资源存放。 一、使用cocoapod 二、代...

  • 小肤iOS开发代码规范_v1.0

    For Objective-C , 2018.8.2 Ⅰ.前言Ⅱ.命名规范Ⅲ.代码注释规范Ⅳ.代码格式化规范Ⅴ....

  • 代码规范

    代码规范 1. 概述 欢迎使用代码规范, 这个是我借鉴京东前端代码规范,组织的内部规范。旨在增强团队开发协作、提高...

  • PSR-2- Coding Style Guide 编码风格规范

    代码风格规范 本篇规范是 PSR-1 基本代码规范的继承与扩展。 本规范希望通过制定一系列规范化PHP代码的规则,...

  • PM篇

    PM 技术篇1.开发规范命名规范,异常处理规范,日志规范,统一框架,代码commit规范,代码评审规范,统一API...

网友评论

      本文标题:代码规范

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