iOS自定义代码段模板(CodeSnippets)和文件模板(.xctemplate)

俗话说“工欲善其事,必先利其器”,写代码的时候,我们经常会重复一些代码或者项目结构,很多时候我都是重复的去写,其实这是最笨的一种方法,之前也在Xcode里面添加过一些自定义代码块和文件模板,但是都没怎么使用过,相信大部分的同学都知道怎么去添加,但是还是做个记录吧,给跟我一样不经常使用的同学一些参考,对我们写代码的效率提升还是挺有帮助的。

1.自定义代码块

在写代码的时候,我们经常要定义一些属性,例如:

@property (nonatomic, copy) NSString *name;
@property (nonatomic, weak) id <UITableViewDelegate> delegate;

一般我都是自己手动的去写,每次都要从头写一遍,其实Xcode中可以自定义一些常用的代码块,通过输入快捷方式来补全代码,这样会减少很多工作量。

例如我们想把上面的字符串属性的代码块通过输入一个快捷方式strp来自动补全,步骤如下:

  1. 先在.h中输入
    @property (nonatomic, copy) NSString *<#name#>
    因为字符串属性@property (nonatomic, copy) NSString *这一段都是固定的,只有最后的一个属性名称是需要我们修改的,把要修改的地方加上<#占位符#>,到时候我们只要修改占位符中的内容就行了。

2.在Xcode右下角找到如下图所示的代码块模块:


代码块

选中上面的代码段,拖入其中,会弹出下面的窗口:

代码块2

Title是标题,描述代码块内容
platform是针对哪个平台,选All就可以了。
Language是语言。
Completeion Shortcut是快捷方式,当我们输入这个设置的快捷方式时,Xcode会自动补全代码。
Completion Scopes代表代码块的范围,比如我们添加的字符串属性就是在.h文件中的interface这个范围内才会自动补全

将内容补充完整,如下:

补充完整

点击“done“之后在代码块模块中就多出了一个代码片段,如下图:

代码片段

保存之后,以后再写字符串属性的时候,就可以直接通过输入strp,这个时候就可以看到Xcode自动补全的代码块了,直接回车修改一下后面的属性名就行了。

自动补全

对于经常要重复写的代码块,比如属性,注释等,可以通过上面的方法来通过一个快捷键自动补全,有的时候会方便很多。

其实,Xcode的所有代码模板是用一个plist格式xml文件描述的,这文件存储在Xcode的安装目录:
/Applications/Xcode.app/Contents/Frameworks/IDEKit.framework/Versions/A/Resources/SystemCodeSnippets.codesnippets

自己定义的代码块是在以下目录下:
~/Library/Developer/Xcode/UserData/CodeSnippets/

感兴趣的同学可以自己去研究一下。

2.自定义文件模板

当我们在项目中创建一个新的ViewController时,.m文件中一般都会已经存在下面这段代码:

.m代码

这是系统的UIViewController文件的模板,为我们添加了一些代码,省去了我们的部分工作,但是一般自定义的ViewController中我们都会有一些我们自己习惯的常见模块,比如下面是水哥的ViewController中常见模块:

- (void)viewDidLoad {
    [super viewDidLoad];
    // Do any additional setup after loading the view.
    [self setupUI];
    [self loadData];
}

- (void)viewWillAppear:(BOOL)animated {
    [super viewWillAppear:animated];
    
}

- (void)viewWillDisappear:(BOOL)animated {
    [super viewWillDisappear:animated];
    
}

- (void)didReceiveMemoryWarning {
    [super didReceiveMemoryWarning];
    // Dispose of any resources that can be recreated.
}
#pragma mark - Initial Methods

/** 视图初始化 */
- (void)setupUI {
    
    
}

/** 加载数据 */
- (void)loadData {
    
    
}
#pragma mark - Setter & Getter

#pragma mark - Target Mehtods

#pragma mark - Notification Method

#pragma mark - Private Method

#pragma mark - Public Method

#pragma mark - UITableView Delegate &Datasource

#pragma mark - Other Delegate

如果这些代模块注释每次都要重新写的话,显然是比较麻烦的,我们可以通过自定义一个ViewController的文件模板来自动生成这些代码。

  1. Xcode的文件模板路径一般在下面这个目录:(我的是Xcode8.2)
    /Applications/Xcode.app/Contents/Developer/Platforms/iPhoneOS.platform/Developer/Library/Xcode/Templates
    进入上面这个路径,可以看到如下所以的目录结构:

    目录结构

如果我们选择创建一个新文件,可以看到每个目录对应的正好是创建文件的不同模块,如下图:

创建文件

File Templates下面新建一个我们自己的文件夹Custom。如果要自己创建这些文件模板的话会比较麻烦,所以我们直接从Source文件夹下面,复制一份Cocoa Touch Class.xctemplateCustom文件夹中来进行修改,将Cocoa Touch Class.xctemplate改成我们自己的名字,例如:SG Touch Class.xctemplate。进入SG Touch Class.xctemplate可以看到其中有非常多的文件模板:

文件模板

因为我们这个例子只要说明ViewController的模板是如何生成的,其他的都是同一个道理,我们只需要修改下面的内容:

UIViewControllerObjective-C
UIViewControllerSwift
UIViewControllerXIBObjective-C
UIViewControllerXIBSwift
//模板的图标,可以自己用图标进行替换
TemplateIcon.png
TemplateIcon@2x.png
//模板配置文件,这个文件是修改的重点
TemplateInfo.plist

可以把其他不需要的文件都删除,把文件夹的名字前缀改成自己的命名 ,最后剩下的如下图:

自定义模板

进入SGViewControllerObjective-C文件夹,先修改.h文件:

___IMPORTHEADER_cocoaTouchSubclass___

@interface ___FILEBASENAMEASIDENTIFIER___ : ___VARIABLE_cocoaTouchSubclass___

@end

改成:

___IMPORTHEADER_cocoaTouchSubclass___

@interface ___FILEBASENAMEASIDENTIFIER___ : UIViewController

@end

___VARIABLE_cocoaTouchSubclass___在生成文件的时候会自动替换为我们的类名,如果不改成UIViewController的话,生成的.h文件中,将会是:
@interface ___FILEBASENAMEASIDENTIFIER___ : SGViewController

再修改.m文件,将.m中的内容替换成我们自定义的代码模块:

- (void)viewDidLoad {
    [super viewDidLoad];
    // Do any additional setup after loading the view.
    [self setupUI];
    [self loadData];
}

- (void)viewWillAppear:(BOOL)animated {
    [super viewWillAppear:animated];
    
}

- (void)viewWillDisappear:(BOOL)animated {
    [super viewWillDisappear:animated];
    
}

- (void)didReceiveMemoryWarning {
    [super didReceiveMemoryWarning];
    // Dispose of any resources that can be recreated.
}


#pragma mark - Initial Methods

/** 视图初始化 */
- (void)setupUI {
    
    
}

/** 加载数据 */
- (void)loadData {
    
    
}

#pragma mark - Setter & Getter

#pragma mark - Target Mehtods

#pragma mark - Notification Method

#pragma mark - Private Method

#pragma mark - Public Method

#pragma mark - UITableView Delegate &Datasource

#pragma mark - Other Delegate

最后打开TemplateInfo.plist来修改其中的配置,在Options中有Item0-Item3四个配置,对应的是我们创建文件时候的四个选项,如下图:

创建文件选项

我们只需要修改下面的内容:(注意这里的SGViewController需要与上面创建的文件夹SGViewControllerObjective-C前面部分一致)

TemplateInfo.plist修改

修改之后保存,在项目中选择创建一个新文件,可以看到下面多出了我们自定义的模板:

创建新文件

选择SG Touch Class,点击Next

模板

Subclass of中填入SGViewController,因为我们修改的是不带XIB的模板,所以不要勾选创建XIB的选项,点击Next ,生成的新的文件中,就已经存在我们自己定义的代码模板了。

按照同样的方式,修改其它三个文件夹中的.h和.m文件就可以了。

总结

Xcode中还有很多这种自定义的模板,比如项目的模板。平时的话没有仔细的去研究,其实如果能够深入研究一下,能更加了解Xcode的一些小技巧,做一个聪明的懒人,在一些重复的事情上尽量去想想有没有办法“偷懒”!

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

推荐阅读更多精彩内容