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

阅读 975
收藏 40
2017-03-07
原文链接:www.jianshu.com

俗话说“工欲善其事,必先利其器”,写代码的时候,我们经常会重复一些代码或者项目结构,很多时候我都是重复的去写,其实这是最笨的一种方法,之前也在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的一些小技巧,做一个聪明的懒人,在一些重复的事情上尽量去想想有没有办法“偷懒”!

评论