Xcode 自定义模板实践

Posted iOS大全

tags:

篇首语:本文由小常识网(cha138.com)小编为大家整理,主要介绍了Xcode 自定义模板实践相关的知识,希望对你有一定的参考价值。

来源: ios_小松哥

www.jianshu.com/p/b938548cf3f2#


好久没来写文章了,因为生活中有一些琐事,也因为工作比较忙。今天我们来聊聊Xcode的自定义模板。


为何要自定义Xcode模板


有时候公司会要求一定的代码规范,例如控制器中需要用#pragma mark -来分割各个方法们,像这样:


#pragma mark - LifeCycle

 

- (void)dealloc {}

 

- (void)viewDidLoad {}

 

- (void)viewWillAppear:(BOOL)animated {}

 

#pragma mark - UITextFieldDelegate

 

- (BOOL)textFieldShouldReturn:(UITextField *)textField {}

 

#pragma mark - Public

 

#pragma mark - Private

 

#pragma mark - Getter

 

- (NSString *)name {}

 

#pragma mark - Setter

 

- (void)setName:(NSString *)name {}


这样不仅可以分割代码,方便阅读,而且可以方便找到某个方法:



但是每创建一个类就写一遍这些是不是有点繁琐呢,这个时候就要用到Xcode的自定义模板功能了。


修改系统模板样式


Xcode系统模板的路径是/Applications/Xcode.app/Contents/Developer/Platforms/iPhoneOS.platform/Developer/Library/Xcode/Templates/,文件夹里面有文件模板File Templates和工程模板Project Templates,分别对应创建文件时的选项和创建工程时的选项:


Xcode 自定义模板实践


创建文件界面


Xcode 自定义模板实践


创建工程界面


我们用的最多就是File Templates/Source/Cocoa Touch Class.xctemplate里面的模板。里面长的是这样的:


Xcode 自定义模板实践


Cocoa Touch Class.xctemplate


例如我们今天需要改UIViewController的模板,就需要改其中的UIViewControllerObjective-C、 UIViewControllerSwift、UIViewControllerXIBObjective-C、UIViewControllerXIBSwift。他们的区别从名字上就能看出来,就是OC与Swift,是否用Xib的区别。


我们以OC并且不用Xib为例,打开UIViewControllerObjective-C中的___FILEBASENAME___.m文件:


//

//  ___FILENAME___

//  ___PROJECTNAME___

//

//  Created by ___FULLUSERNAME___ on ___DATE___.

//___COPYRIGHT___

//

 

#import "___FILEBASENAME___.h"

 

@interface ___FILEBASENAMEASIDENTIFIER___ ()

 

@end

 

@implementation ___FILEBASENAMEASIDENTIFIER___

 

- (void)viewDidLoad {

    [super viewDidLoad];

    // Do any additional setup after loading the view.

}

 

- (void)didReceiveMemoryWarning {

    [super didReceiveMemoryWarning];

    // Dispose of any resources that can be recreated.

}

 

/*

#pragma mark - Navigation

 

// In a storyboard-based application, you will often want to do a little preparation before navigation

- (void)prepareForSegue:(UIStoryboardSegue *)segue sender:(id)sender {

    // Get the new view controller using [segue destinationViewController].

    // Pass the selected object to the new view controller.

}

*/

 

@end


是不是很熟悉,就是我们创建一个控制器后.m里面的代码。其中的一些宏的意义是:


宏名 意义
___FILENAME___ 文件名包括后缀
___PROJECTNAME___ 工程名
___FULLUSERNAME___ 用户的名字
___DATE___ 当前日期,年/月/日
___COPYRIGHT___ 版权
___FILEBASENAME___ 不带后缀的文件名
___FILEBASENAMEASIDENTIFIER___ 不带后缀的文件名


这个文件默认是不让修改的,我们可以修改他的权限,或者复制一份到别处,修改完替换原文件。总之修改其中的内容为:


//

//  ___FILENAME___

//  ___PROJECTNAME___

//

//  Created by ___FULLUSERNAME___ on ___DATE___.

//___COPYRIGHT___

//

 

#import "___FILEBASENAME___.h"

 

@interface ___FILEBASENAMEASIDENTIFIER___ ()

 

@end

 

@implementation ___FILEBASENAMEASIDENTIFIER___

 

#pragma mark - LifeCycle

 

- (void)viewDidLoad

{

    [super viewDidLoad];

}

 

 

#pragma mark - UITableViewDelegate

 

#pragma mark - Public

 

#pragma mark - Private

 

#pragma mark - Getter

 

#pragma mark - Setter

 

@end


然后把这个文件去替换原来的文件。替换成功后新建一个控制器,就会是我们自定义的结构了,如果没生效的话,可以重启下Xcode哦:


新建一个控制器


Xcode 自定义模板实践


相信到这里,其他的模板你也一定会改了吧。


使用自定义模板


如果更改系统模板会有问题,就是xcode更新后我们所做的更改就没有了。

为了解决这个问题,我们可以在~/Library/Developer/Xcode/Templates路径下新建一个Templates文件夹,再在Templates里新建一个Custom的文件夹,把系统的Cocoa Touch Class.xctemplate复制进去,然后进行修改就可以了。


这样在创建文件的时候,在最下面就会有你自定义的模板选项:



选择模板

好了,到这里大家应该都熟悉了Xcode模板的基本使用,快去探索更多高级用法吧!


看完本文有收获?请分享给更多人

关注「 iOS大全 」,提升iOS技能

以上是关于Xcode 自定义模板实践的主要内容,如果未能解决你的问题,请参考以下文章

VSCode自定义代码片段——.vue文件的模板

VSCode自定义代码片段1——vue主模板

VSCode自定义代码片段(vue主模板)

VSCode自定义代码片段2——.vue文件的模板

Xcode自定义代码块

方法:自定义Xcode模板样式