iOS代码编写规范

一.注释规范

1.创建类添加类注释
/**
 *<#空格#>SanW--2017.5.3--公共参数
 */
@interface PTCommonParams : NSObject
2.属性注释
/**
 *<#空格#>设备系统版本
 */
(///<#空格#>设备系统版本)
@property<#空格#> (nonatomic,copy)<#空格#>NSString<#空格#>*osVersion;
3.更改对方代码时打上注释
#warning mark<#空格#>- SanW--2017.5.3--解决数组越界奔溃(原因)
4.创建变量
 //<#空格#>是否退出(变量以下划线_开头)
BOOL<#空格#>_isQuit;

二.命名规范(驼峰命名法)

1.It is good to be both clear and brief as possible, but clarity shouldn’t suffer because of brevity:
2.In general, don’t abbreviate names of things. Spell them out, even if they’re long:
3.However, a handful of abbreviations are truly common and have a long history of use. You can continue to use them; see Acceptable Abbreviations and Acronyms.
4.Avoid ambiguity in API names, such as method names that could be interpreted in more than one way.

1.类,方法,属性,变量命名
//<#空格#>类命名一般添加个人/公司/应用程序大写字母作为前缀
PTHoneController,PTUserModel,PTHeaderView
//<#空格#>方法命名主要从 --要什么 -- 做什么
-<#空格#>(NSString<#空格#>*)itemNamed:(NSString<#空格#>*)name      
-<#空格#>(NSString<#空格#>*)findItemWithName:(NSString<#空格#>*)name  
-<#空格#>(NSString<#空格#>*)itemAtIndex:(NSUInteger)index 
//<#空格#>变量名称以下划线开头_
BOOL<#空格#>_isQuit;
2.枚举表示状态、选项

定义的枚举类型名称应以 2~3 个大写字母开头,而这通常与项目设置的类文件前缀相同,跟随其后的命名应采用驼峰命名法则,命名应准确表述枚举表示的意义,枚举中各个值都应以定义的枚举类型开头,其后跟随各个枚举值对应的状态、选项或者状态码。

// 名称以类名前缀+表示的意义 值:枚举名+对应的状态、选项或者状态码
typedef NS_ENUM(NSInteger,ReportHeaderType) {
ReportHeaderTypeAudio, //<#空格#>音频
ReportHeaderTypeVideo //<#空格#>视频
};
typedef NS_OPTIONS(NSUInteger, UIViewAutoresizing) {
UIViewAutoresizingNone = 0,
UIViewAutoresizingFlexibleLeftMargin = 1 << 0,
UIViewAutoresizingFlexibleWidth = 1 << 1,
UIViewAutoresizingFlexibleRightMargin = 1 << 2,
UIViewAutoresizingFlexibleTopMargin = 1 << 3
};
3.常量

最好以宏代替部分方法,常量用const去定义

  • 1> 使用宏预处理定义以k+代表意义定义,这样定义的常量无类型信息,且如果你在调试时想要查看 kRadius 的值却无从下手,因为在预处理阶段kRadius 就已经被替换了,不便于调试
    //<#空格#>圆角弧度
    #define kRadius 6
  • 2> 使用类型常量为常量带入类型信息
//<#空格#>通常以个人/公司/类名大写字母作为前缀+代表的意义+Const后缀
const<#空格#>NSTimeInterval<#空格#>PTAnimationDurationConst<#空格#>=<#空格#>0.3;
NSString<#空格#>*const<#空格#>UIApplicationLaunchOptionsLocalNotificationKey;
//<#空格#>消息区分私信
.h
extern<#空格#>NSString<#空格#>*const<#空格#>MESSAGE_LIVE_TYPE;
.m
NSString<#空格#>*const<#空格#>MESSAGE_LIVE_TYPE<#空格#>=<#空格#>@"直播间主播私信";
4.分类及其分类方法

分类名称以个人/公司/类名大写字母作为前缀+系统类名+ Ex后缀,分类中的方法名以个人/公司/类名小写字母作为前缀,且以下划线连接前缀与方法名。

UIColor+PTColorEx.h
//<#空格#>16进制颜色转换
+<#空格#>(UIColor<#空格#>*)pt_colorWithHexString:(NSString<#空格#>*)hexString;
5.block和协议命名
  • Block
//<#空格#>block表示的意义首字母大写 + Block后缀
@property<#空格#>(nonatomic,copy)<#空格#>void<#空格#>(^ChooseClassfyBlock)(PTLiveClassfyModel<#空格#>*classfyInfo,UIButton<#空格#>*sender);
  • 2.代理协议
//<#空格#>使用protocol定义代理协议时类名+Delegate 后缀
@protocol<#空格#>PTHomeViewDelegate<#空格#><NSObject>
6.判断(switch/ if.....else)

在项目中尽量减少if...else 的使用,使用switch便利,相对而言if条件判断,switch匹配

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

推荐阅读更多精彩内容