Xcode 文件模版制作

时间:2024-04-13 12:29:32

一、为什么要定义模板类

遵守代码规范可以提高代码可读性, 降低后期维护成本. 当我们定下了一个团队都认同的代码规范, 如很多VC的代码都可以按照下面来组织:

Xcode 文件模版制作

另外,你也可以通过模版直接生成多个文件;

对于比较大的项目,由于个人所在组内对代码规范比较严格,代码层结构比较多,比如我所在的项目,对于一个有tableview的页面,必须要遵循如下结构:

Xcode 文件模版制作

每次都要创建这么多类,并且类里面很多代码都是重复或者类似的;而文件模版正好可以解决这个问题。

二、模板类如何制作

从头制作一个模板类有些坑. 我们采用简单的办法, 先拷贝一个模板类, 然后修改成自己需要的样子. 这里有个我写好的自己工程用的文件模版:

https://github.com/Carl-Yao/MVVMFileTemplate.git

在下到的模版中可以看到如下结构

Xcode 文件模版制作

___FILEBASENAME___为你在xcode里new file时输入的名字;

___VARIABLE_cocoaSubclass___为你在xcode里选择的基类名字,这里的模版,我把这个洪注释掉,改为其他类作为基类

Xcode 文件模版制作

选择基类为MVVM2时,生成的文件就是MVVM1目录下的文件以及结构;

选择基类为NSObject时,生成的文件就是NSObject目录下的文件;

如果想新增加自定义的类为基类,可以在TemplateInfo.plist里的Options -> Item 1 -> Values下添加item,起一个名字,并创建一个相同名字的目录;

Xcode 文件模版制作

关于配置属性列表以及编辑模版文件常用的宏的详细说明可以参照如下网址:

http://www.bobmccune.com/2012/03/04/creating-custom-xcode-4-file-templates/

 

三、如何用定义好的模板类

把前面提到的模版文件拷贝到Xcode的文件模板文件夹里 /Applications/Xcode.app/Contents/Developer/Library/Xcode/Templates/File Templates/Source. 这样就可以使用了.

在工程适当位置右键-》new file-》选择自定义的文件模版:

Xcode 文件模版制作

输入业务相关的名字,如Wealth-》确定

Xcode 文件模版制作

即可在工程生成如下文件目录:

Xcode 文件模版制作

有瑕疵的地方是添加的文件夹目录都是引用到工程的(蓝色的文件夹),需要删除引用后再拖到工程中:

Xcode 文件模版制作

ps:工程模版因为使用较少,暂时不做讲解