Xcode 定制文件头部的注释

在Xcode中,如果新建文件,会自动在新建的文件上,在默认情况下,都会在其开头添加以下的注释,如下:

//
//  fileName
//  packageName
//
//  Created by userName on Date.
//  Copyright © year organization. All rights reserved.
//

在Xcode9中,苹果提供了方法可以让我们改写这些注释。

首先,创建IDETemplateMacros.plist文件,然后在root下面新建一个名为FILEHEADER的键,它的值为String类型,然后将自定义的注释就放在其中,最后将文件移到以下目录中的一个。

适用于整个工程(个人)

.xcodeproj/xcuserdata/[username].xcuserdatad/

适用于整个工程(共享)

.xcodeproj/xcshareddata/

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

.xcworkspace/xcuserdata/[username].xcuserdatad/

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

.xcworkspace/xcshareddata/

适用于整个Xcode

~/Library/Developer/Xcode/UserData/

需要注意的是,这些注释中的文字是可以通过苹果提供的宏动态改变的,下面列举出几个常用的宏(如果要添加这样的宏,需要在名字左右各添加三个"_"):

DATE

现在的日期

FILENAME

所在文件的全名

ORGANIZATIONNAME

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

PACKAGENAME

包名

PRODUCTNAME

应用名称

PROJECTNAME

工程名

TIME

时间

FULLUSERNAME

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

WORKSPACENAME

工作区名称

YEAR

当前年份

COPYRIGHT

版权字符串,由机构名称和创建年份构成,比如设置了机构为Apple,且在2018年建立的文件,则其版权字符串为

Copyright © 2018 Apple. All rights reserved.
如果没有设置机构名称,则为空

更多的宏可以在Xcode Help中查找Text macros reference

可以看出,Xcode默认的文字头部注释的默认定义如下


//  ___FILENAME___
//  ___PACKAGENAME___
//
//  Created by ___FULLUSERNAME___ on ___DATE___.
//  ___COPYRIGHT___
//

PS:Xcode新建文件中第一行默认是加了"//"的,因此我们自定义注释的第一行中只需要敲回车就行

比如遇到一个场景,我们需要更改默认的作者名字,如果直接修改账户名的话,可能会丢掉管理员权限(虽然可以重新申请权限,不过流程很麻烦),那么,我们就可以通过上面的办法更改文件头部的注释如下:


//  ___FILENAME___
//  ___PACKAGENAME___
//
//  Created by yourName on ___DATE___.
//  ___COPYRIGHT___
//

在按上面提到的步骤操作,就能更改作者的名字了

你可能感兴趣的:(Xcode 定制文件头部的注释)