自定义Xcode 文件头部的注释

5,055 阅读2分钟

在Xcode10中新建文件,系统会自动在新建文件的头部添加注释模板,如下:

有时候我们可能有特殊的需求想要自定义这些注释,在Xcode9之后,苹果也给我们提供了方法,可以很方便的修改这些默认注释。

1、创建IDETemplateMacros.plist文件

其中 FILEHEADER 是系统所有新建文件头部的注释说明,通过覆盖这个宏就可以自定义头部信息了(FILEHEADER 宏在文末有提供了查看方法)

2、编辑内容

因为Xcode新建文件中第一行默认是加了“//”的,所以自定义注释的第一行中需要敲下回车


// 🙏不出bug
//  Created by ___FULLUSERNAME___ on ___DATE___.
//  ___COPYRIGHT___
//

3、放置IDETemplateMacros.plist文件

现将文件放置到<ProjectName>.xcodeproj/xcuserdata/[username].xcuserdatad/目录下,就可以了,然后新建文件查看效果

注意:

plist文件放置的位置不同,适用的范围也不同

适用于整个工程(个人)

<ProjectName>.xcodeproj/xcuserdata/[username].xcuserdatad/

适用于整个工程(共享)

<ProjectName>.xcodeproj/xcshareddata/

适用于整个工作区(个人)

<WorkspaceName>.xcworkspace/xcuserdata/[username].xcuserdatad/

适用于整个工作区(共享)

<WorkspaceName>.xcworkspace/xcshareddata/

适用于整个Xcode

~/Library/Developer/Xcode/UserData/

苹果提供了很多示例中的系统宏,下面是几个常用(添加宏的时候,需要在宏左右各添加三个“_”)

DATE:现在的日期

FILENAME:所在文件的全名

ORGANIZATIONNAME:机构名称,在配置文件中获取

PACKAGENAME:包名

PRODUCTNAME:应用名称

PROJECTNAME:工程名

TIME:时间

FULLUSERNAME:用户名,为当前MasOS的用户账号名

WORKSPACENAME:工作区名称

YEAR:当前年份

COPYRIGHT:版权字符串,由机构名称和创建年份构成,例如Copyright © 2019 CY. All rights reserved.

FILEHEADER宏的系统设置探究

通过Xcode ▸ Contents ▸ Developer ▸ Platforms ▸ iPhoneOS.platform ▸ Developer ▸ Library ▸ Xcode ▸ Templates路径,然后搜索Cocoa Touch Class.xctemplate,以其中的NSObjectObjective-C文件为例