PS:这是一篇被大家写了很多遍的开发小技巧。
此处以Xcode Version 10.1 (10B61)
为例,进行代码片段的自定义。
在实际开发中,都会遇到这样的问题:比如经常要大量的重复写属性的声明、注释等等问题。
为了避免重复的工作,我们会想如果能每次简单敲几个关键字,就出现对应的注释、声明代码,该多好!
方便如Xcode
,早已为我们提供了这样的功能 ——Code Snippets
。
在你创建好自定义的代码片段后,每当重用这些代码片段时,会给你带来很大的便捷。
-
占位符
你可能在使用
Xcode
其他代码片段时注意到过占位符:
在
Xcode
中,占位符标记由<#
和#>
组成,占位符文本在两个#
中间。按照上述格式把它输入到
Xcode
中,然后就会看到#
#
标记之间的文本变换成了⬆️图所示效果。
-
创建
在
Xcode
内,先写上这样一段占位符
代码,随你爱好写在.h
或是.m
中。
@property(nonatomic, strong) <#type#> * <#name#>;
选中上面这行代码,右键,出现如⬇️图所示菜单选项
选择
Create code snippet
,出现如⬇️图所示内容
对⬆️图内的东西进行一个解释说明。
Title
:代码片段的名称 (在代码片段库的列表中,以及敲击快捷方式时,会出现Title
内所填写内容)。
Summary
:对代码片段的功能的简要描述 (可写可不写,仅仅会在代码片段库列表中显示)。
Platform
:将代码片段的可见性(即,可用快捷方式调用的)限制为指定的平台,可以选择All
,也可以选择别的,根据需要而定。
Language
:将代码片段的可见性(即,可用快捷方式调用的)限制为指定的语言。 根据你自己写的而定。最常见的是C
、Objective-C
、C++
或Objective-C++
。
Completion Shortcut
:使用代码片段时的快捷方式。 举个例子,比如这里填写的是@strong
,在程序中打出@strong
,就会显示代码块的内容。对于常用的片段,快捷方式应该相对较短。Xcode
不会警告存在冲突 / 重叠的快捷方式,所以确保你的快捷方式不会与现有的快捷方式重叠。
Completion Scopes
:将代码片段的可见性(即,可用快捷方式调用的)限制为指定的范围。 举个例子,if / else 语句只能在方法或函数实现中自动完成。
-
使用
将上述解释的东西填写完毕后,就创建了所需要的代码片段。
在允许的范围内输入快捷方式
关键字
进行使用,效果如⬇️图所示。
当然,你还可以选择使用光标拖拽的方式进行使用。
-
常用代码片段(仅供参考)
// 普通注释代码片段
/**
* <#注释1#>
* <#注释2#>
*/
// 方法注释代码片段
/**
* <#方法说明#>
* <#@param#> <#注释#>
* <#@param#> <#注释#>
*/
// strong
@property (nonatomic,strong) <#Class#> *<#object#>;
// weak:
@property (nonatomic,weak) <#Class#> *<#object#>;
// copy:
@property (nonatomic,copy) NSString *<#string#>;
// assign:
@property (nonatomic,assign) <#Class#> <#property#>;
// delegate:
@property (nonatomic,weak) id<<#protocol#>> <#delegate#>;
//block:
@property (nonatomic,copy) <#Block#> <#block#>;
// mark:
#pragma mark -- <#mark#>
// ReUseCell:
static NSString *rid=<#rid#>; <#Class#> *cell=[tableView dequeueReusableCellWithIdentifier:rid]; if(cell==nil){ cell=[[<#Class#> alloc] initWithStyle:UITableViewCellStyleDefault reuseIdentifier:rid]; } return cell;
// MainGCD:
dispatch_async(dispatch_get_main_queue(), ^{ <#code#> });
// AfterGCD:
dispatch_after(dispatch_time(DISPATCH_TIME_NOW, (int64_t)(<#delayInSeconds#> * NSEC_PER_SEC)), dispatch_get_main_queue(), ^{ <#code to be executed after a specified delay#> });
OnceGCD:
static dispatch_once_t onceToken; dispatch_once(&onceToken, ^{ <#code to be executed once#> });
代码块的删除
选中代码块,然后按 delete键,就可以了。
代码片段备份:
Xcode 中的代码片段默认放在下面的目录中:
~/Library/Developer/Xcode/UserData/CodeSnippets
我们可以将目录中的代码片段备份,也可以将其直接拷出来放在不同的电脑上使用。
编程不是成为一个专业的打字员,所以不要给自己增加任何困难。 如果你发现自己在键入一些机械、死记硬背的代码成语时呻吟,那么花一分钟为它创建一个片段吧!